diff --git a/androidmanagement/v1/androidmanagement-api.json b/androidmanagement/v1/androidmanagement-api.json index 9f7e8d967a3..77372156419 100644 --- a/androidmanagement/v1/androidmanagement-api.json +++ b/androidmanagement/v1/androidmanagement-api.json @@ -1168,7 +1168,7 @@ } } }, - "revision": "20241031", + "revision": "20241104", "rootUrl": "https://androidmanagement.googleapis.com/", "schemas": { "AdbShellCommandEvent": { @@ -4834,7 +4834,7 @@ "type": "array" }, "addUserDisabled": { - "description": "Whether adding new users and profiles is disabled.", + "description": "Whether adding new users and profiles is disabled. For devices where managementMode is DEVICE_OWNER this field is ignored and the user is never allowed to add or remove users.", "type": "boolean" }, "adjustVolumeDisabled": { diff --git a/androidmanagement/v1/androidmanagement-gen.go b/androidmanagement/v1/androidmanagement-gen.go index 3120a1e71dd..64ea8e32448 100644 --- a/androidmanagement/v1/androidmanagement-gen.go +++ b/androidmanagement/v1/androidmanagement-gen.go @@ -4730,7 +4730,9 @@ type Policy struct { // AccountTypesWithManagementDisabled: Account types that can't be managed by // the user. AccountTypesWithManagementDisabled []string `json:"accountTypesWithManagementDisabled,omitempty"` - // AddUserDisabled: Whether adding new users and profiles is disabled. + // AddUserDisabled: Whether adding new users and profiles is disabled. For + // devices where managementMode is DEVICE_OWNER this field is ignored and the + // user is never allowed to add or remove users. AddUserDisabled bool `json:"addUserDisabled,omitempty"` // AdjustVolumeDisabled: Whether adjusting the master volume is disabled. Also // mutes the device. diff --git a/chat/v1/chat-api.json b/chat/v1/chat-api.json index e8449168851..62ce8ed92ed 100644 --- a/chat/v1/chat-api.json +++ b/chat/v1/chat-api.json @@ -763,7 +763,7 @@ "messages": { "methods": { "create": { - "description": "Creates a message in a Google Chat space. For an example, see [Send a message](https://developers.google.com/workspace/chat/create-messages). The `create()` method requires either [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) or [app authentication](https://developers.google.com/workspace/chat/authorize-import). Chat attributes the message sender differently depending on the type of authentication that you use in your request. The following image shows how Chat attributes a message when you use app authentication. Chat displays the Chat app as the message sender. The content of the message can contain text (`text`), cards (`cardsV2`), and accessory widgets (`accessoryWidgets`). ![Message sent with app authentication](https://developers.google.com/workspace/chat/images/message-app-auth.svg) The following image shows how Chat attributes a message when you use user authentication. Chat displays the user as the message sender and attributes the Chat app to the message by displaying its name. The content of message can only contain text (`text`). ![Message sent with user authentication](https://developers.google.com/workspace/chat/images/message-user-auth.svg) The maximum message size, including the message contents, is 32,000 bytes.", + "description": "Creates a message in a Google Chat space. For an example, see [Send a message](https://developers.google.com/workspace/chat/create-messages). The `create()` method requires either [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) or [app authentication](https://developers.google.com/workspace/chat/authorize-import). Chat attributes the message sender differently depending on the type of authentication that you use in your request. The following image shows how Chat attributes a message when you use app authentication. Chat displays the Chat app as the message sender. The content of the message can contain text (`text`), cards (`cardsV2`), and accessory widgets (`accessoryWidgets`). ![Message sent with app authentication](https://developers.google.com/workspace/chat/images/message-app-auth.svg) The following image shows how Chat attributes a message when you use user authentication. Chat displays the user as the message sender and attributes the Chat app to the message by displaying its name. The content of message can only contain text (`text`). ![Message sent with user authentication](https://developers.google.com/workspace/chat/images/message-user-auth.svg) The maximum message size, including the message contents, is 32,000 bytes. For [webhook](https://developers.google.com/workspace/chat/quickstart/webhooks) requests, the response doesn't contain the full message. The response only populates the `name` and `thread.name` fields in addition to the information that was in the request.", "flatPath": "v1/spaces/{spacesId}/messages", "httpMethod": "POST", "id": "chat.spaces.messages.create", @@ -1344,7 +1344,7 @@ } } }, - "revision": "20241029", + "revision": "20241031", "rootUrl": "https://chat.googleapis.com/", "schemas": { "AccessSettings": { @@ -2117,7 +2117,7 @@ "readOnly": true }, "unicode": { - "description": "A basic emoji represented by a unicode string.", + "description": "Optional. A basic emoji represented by a unicode string.", "type": "string" } }, @@ -2129,11 +2129,13 @@ "properties": { "emoji": { "$ref": "Emoji", - "description": "Emoji associated with the reactions." + "description": "Output only. Emoji associated with the reactions.", + "readOnly": true }, "reactionCount": { - "description": "The total number of reactions using the associated emoji.", + "description": "Output only. The total number of reactions using the associated emoji.", "format": "int32", + "readOnly": true, "type": "integer" } }, @@ -4239,10 +4241,10 @@ "properties": { "emoji": { "$ref": "Emoji", - "description": "The emoji used in the reaction." + "description": "Required. The emoji used in the reaction." }, "name": { - "description": "The resource name of the reaction. Format: `spaces/{space}/messages/{message}/reactions/{reaction}`", + "description": "Identifier. The resource name of the reaction. Format: `spaces/{space}/messages/{message}/reactions/{reaction}`", "type": "string" }, "user": { diff --git a/chat/v1/chat-gen.go b/chat/v1/chat-gen.go index 9293d4fff83..fc8af65bd0f 100644 --- a/chat/v1/chat-gen.go +++ b/chat/v1/chat-gen.go @@ -1572,7 +1572,7 @@ func (s DriveLinkData) MarshalJSON() ([]byte, error) { type Emoji struct { // CustomEmoji: Output only. A custom emoji. CustomEmoji *CustomEmoji `json:"customEmoji,omitempty"` - // Unicode: A basic emoji represented by a unicode string. + // Unicode: Optional. A basic emoji represented by a unicode string. Unicode string `json:"unicode,omitempty"` // ForceSendFields is a list of field names (e.g. "CustomEmoji") to // unconditionally include in API requests. By default, fields with empty or @@ -1595,9 +1595,10 @@ func (s Emoji) MarshalJSON() ([]byte, error) { // EmojiReactionSummary: The number of people who reacted to a message with a // specific emoji. type EmojiReactionSummary struct { - // Emoji: Emoji associated with the reactions. + // Emoji: Output only. Emoji associated with the reactions. Emoji *Emoji `json:"emoji,omitempty"` - // ReactionCount: The total number of reactions using the associated emoji. + // ReactionCount: Output only. The total number of reactions using the + // associated emoji. ReactionCount int64 `json:"reactionCount,omitempty"` // ForceSendFields is a list of field names (e.g. "Emoji") to unconditionally // include in API requests. By default, fields with empty or default values are @@ -4680,9 +4681,9 @@ func (s QuotedMessageMetadata) MarshalJSON() ([]byte, error) { // Reaction: A reaction to a message. type Reaction struct { - // Emoji: The emoji used in the reaction. + // Emoji: Required. The emoji used in the reaction. Emoji *Emoji `json:"emoji,omitempty"` - // Name: The resource name of the reaction. Format: + // Name: Identifier. The resource name of the reaction. Format: // `spaces/{space}/messages/{message}/reactions/{reaction}` Name string `json:"name,omitempty"` // User: Output only. The user who created the reaction. @@ -8246,6 +8247,11 @@ type SpacesMessagesCreateCall struct { // can only contain text (`text`). !Message sent with user authentication // (https://developers.google.com/workspace/chat/images/message-user-auth.svg) // The maximum message size, including the message contents, is 32,000 bytes. +// For webhook +// (https://developers.google.com/workspace/chat/quickstart/webhooks) requests, +// the response doesn't contain the full message. The response only populates +// the `name` and `thread.name` fields in addition to the information that was +// in the request. // // - parent: The resource name of the space in which to create a message. // Format: `spaces/{space}`. diff --git a/cloudchannel/v1/cloudchannel-api.json b/cloudchannel/v1/cloudchannel-api.json index 6ca03c1f02f..85f3b758a02 100644 --- a/cloudchannel/v1/cloudchannel-api.json +++ b/cloudchannel/v1/cloudchannel-api.json @@ -2289,7 +2289,7 @@ } } }, - "revision": "20241024", + "revision": "20241102", "rootUrl": "https://cloudchannel.googleapis.com/", "schemas": { "GoogleCloudChannelV1ActivateEntitlementRequest": { @@ -2429,6 +2429,10 @@ }, "type": "array" }, + "priceReferenceId": { + "description": "Optional. Price reference ID for the offer. Optional field only for offers that require additional price information. Used to guarantee that the pricing is consistent between quoting the offer and placing the order. Yet to be implemented: this field is currently not evaluated in the API if populated in a request.", + "type": "string" + }, "purchaseOrderId": { "description": "Optional. Purchase order id provided by the reseller.", "type": "string" @@ -2955,7 +2959,7 @@ "type": "string" }, "eventType": { - "description": "Type of event which happened on the customer.", + "description": "Type of event which happened for the customer.", "enum": [ "TYPE_UNSPECIFIED", "PRIMARY_DOMAIN_CHANGED", @@ -3104,6 +3108,10 @@ }, "type": "array" }, + "priceReferenceId": { + "description": "Optional. Price reference ID for the offer. Optional field only for offers that require additional price information. Used to guarantee that the pricing is consistent between quoting the offer and placing the order. Yet to be implemented: this field is currently not evaluated in the API if populated in a request.", + "type": "string" + }, "provisionedService": { "$ref": "GoogleCloudChannelV1ProvisionedService", "description": "Output only. Service provisioning details for the entitlement.", @@ -3324,7 +3332,7 @@ "type": "string" }, "eventType": { - "description": "Type of event which happened on the entitlement.", + "description": "Type of event which happened for the entitlement.", "enum": [ "TYPE_UNSPECIFIED", "CREATED", @@ -4316,6 +4324,10 @@ "offer": { "$ref": "GoogleCloudChannelV1Offer", "description": "Offer." + }, + "priceReferenceId": { + "description": "Optional. Price reference ID for the offer. Optional field only for offers that require additional price information. Used to guarantee that the pricing is consistent between quoting the offer and placing the order.", + "type": "string" } }, "type": "object" @@ -4888,6 +4900,10 @@ "offer": { "$ref": "GoogleCloudChannelV1Offer", "description": "Offer with parameter constraints updated to allow the Transfer." + }, + "priceReferenceId": { + "description": "Optional. Price reference ID for the offer. Optional field only for offers that require additional price information. Used to guarantee that the pricing is consistent between quoting the offer and placing the order.", + "type": "string" } }, "type": "object" @@ -5026,7 +5042,7 @@ "type": "string" }, "eventType": { - "description": "Type of event performed on the Channel Partner.", + "description": "Type of event which happened for the channel partner.", "enum": [ "TYPE_UNSPECIFIED", "LINK_STATE_CHANGED", @@ -5112,7 +5128,7 @@ "type": "string" }, "eventType": { - "description": "Type of event which happened on the customer.", + "description": "Type of event which happened for the customer.", "enum": [ "TYPE_UNSPECIFIED", "PRIMARY_DOMAIN_CHANGED", @@ -5302,7 +5318,7 @@ "type": "string" }, "eventType": { - "description": "Type of event which happened on the entitlement.", + "description": "Type of event which happened for the entitlement.", "enum": [ "TYPE_UNSPECIFIED", "CREATED", @@ -5383,6 +5399,31 @@ }, "type": "object" }, + "GoogleCloudChannelV1alpha1OpportunityEvent": { + "description": "Represents Pub/Sub message content describing opportunity updates.", + "id": "GoogleCloudChannelV1alpha1OpportunityEvent", + "properties": { + "eventType": { + "description": "Type of event which happened for the opportunity.", + "enum": [ + "TYPE_UNSPECIFIED", + "CREATED", + "UPDATED" + ], + "enumDescriptions": [ + "Not used.", + "New opportunity created.", + "Existing opportunity updated." + ], + "type": "string" + }, + "opportunity": { + "description": "Resource name of the opportunity. Format: opportunities/{opportunity}", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudChannelV1alpha1Parameter": { "description": "Definition for extended entitlement parameters.", "id": "GoogleCloudChannelV1alpha1Parameter", @@ -5652,6 +5693,10 @@ "entitlementEvent": { "$ref": "GoogleCloudChannelV1alpha1EntitlementEvent", "description": "Entitlement event sent as part of Pub/Sub event to partners." + }, + "opportunityEvent": { + "$ref": "GoogleCloudChannelV1alpha1OpportunityEvent", + "description": "Opportunity event sent as part of Pub/Sub event to partners/integrators." } }, "type": "object" @@ -5885,7 +5930,7 @@ "type": "object" }, "GoogleTypeDecimal": { - "description": "A representation of a decimal value, such as 2.5. Clients may convert values into language-native decimal formats, such as Java's BigDecimal or Python's decimal.Decimal. [BigDecimal]: https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/math/BigDecimal.html [decimal.Decimal]: https://docs.python.org/3/library/decimal.html", + "description": "A representation of a decimal value, such as 2.5. Clients may convert values into language-native decimal formats, such as Java's [BigDecimal](https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/math/BigDecimal.html) or Python's [decimal.Decimal](https://docs.python.org/3/library/decimal.html).", "id": "GoogleTypeDecimal", "properties": { "value": { diff --git a/cloudchannel/v1/cloudchannel-gen.go b/cloudchannel/v1/cloudchannel-gen.go index c3f65697780..9561c434cf1 100644 --- a/cloudchannel/v1/cloudchannel-gen.go +++ b/cloudchannel/v1/cloudchannel-gen.go @@ -560,6 +560,12 @@ type GoogleCloudChannelV1ChangeOfferRequest struct { // available Parameters refer to the Offer.parameter_definitions from the // desired offer. Parameters []*GoogleCloudChannelV1Parameter `json:"parameters,omitempty"` + // PriceReferenceId: Optional. Price reference ID for the offer. Optional field + // only for offers that require additional price information. Used to guarantee + // that the pricing is consistent between quoting the offer and placing the + // order. Yet to be implemented: this field is currently not evaluated in the + // API if populated in a request. + PriceReferenceId string `json:"priceReferenceId,omitempty"` // PurchaseOrderId: Optional. Purchase order id provided by the reseller. PurchaseOrderId string `json:"purchaseOrderId,omitempty"` // RequestId: Optional. You can specify an optional unique request ID, and if @@ -1210,7 +1216,7 @@ type GoogleCloudChannelV1CustomerEvent struct { // Customer: Resource name of the customer. Format: // accounts/{account_id}/customers/{customer_id} Customer string `json:"customer,omitempty"` - // EventType: Type of event which happened on the customer. + // EventType: Type of event which happened for the customer. // // Possible values: // "TYPE_UNSPECIFIED" - Not used. @@ -1381,6 +1387,12 @@ type GoogleCloudChannelV1Entitlement struct { // Google Cloud billing subaccounts, the following Parameter may be accepted as // input: - display_name: The display name of the billing subaccount. Parameters []*GoogleCloudChannelV1Parameter `json:"parameters,omitempty"` + // PriceReferenceId: Optional. Price reference ID for the offer. Optional field + // only for offers that require additional price information. Used to guarantee + // that the pricing is consistent between quoting the offer and placing the + // order. Yet to be implemented: this field is currently not evaluated in the + // API if populated in a request. + PriceReferenceId string `json:"priceReferenceId,omitempty"` // ProvisionedService: Output only. Service provisioning details for the // entitlement. ProvisionedService *GoogleCloudChannelV1ProvisionedService `json:"provisionedService,omitempty"` @@ -1552,7 +1564,7 @@ type GoogleCloudChannelV1EntitlementEvent struct { // Entitlement: Resource name of an entitlement of the form: // accounts/{account_id}/customers/{customer_id}/entitlements/{entitlement_id} Entitlement string `json:"entitlement,omitempty"` - // EventType: Type of event which happened on the entitlement. + // EventType: Type of event which happened for the entitlement. // // Possible values: // "TYPE_UNSPECIFIED" - Not used. @@ -2853,6 +2865,11 @@ func (s GoogleCloudChannelV1ProvisionedService) MarshalJSON() ([]byte, error) { type GoogleCloudChannelV1PurchasableOffer struct { // Offer: Offer. Offer *GoogleCloudChannelV1Offer `json:"offer,omitempty"` + // PriceReferenceId: Optional. Price reference ID for the offer. Optional field + // only for offers that require additional price information. Used to guarantee + // that the pricing is consistent between quoting the offer and placing the + // order. + PriceReferenceId string `json:"priceReferenceId,omitempty"` // ForceSendFields is a list of field names (e.g. "Offer") to unconditionally // include in API requests. By default, fields with empty or default values are // omitted from API requests. See @@ -3733,6 +3750,11 @@ func (s GoogleCloudChannelV1TransferEntitlementsToGoogleRequest) MarshalJSON() ( type GoogleCloudChannelV1TransferableOffer struct { // Offer: Offer with parameter constraints updated to allow the Transfer. Offer *GoogleCloudChannelV1Offer `json:"offer,omitempty"` + // PriceReferenceId: Optional. Price reference ID for the offer. Optional field + // only for offers that require additional price information. Used to guarantee + // that the pricing is consistent between quoting the offer and placing the + // order. + PriceReferenceId string `json:"priceReferenceId,omitempty"` // ForceSendFields is a list of field names (e.g. "Offer") to unconditionally // include in API requests. By default, fields with empty or default values are // omitted from API requests. See @@ -3968,7 +3990,7 @@ type GoogleCloudChannelV1alpha1ChannelPartnerEvent struct { // uses the format: // accounts/{account_id}/channelPartnerLinks/{channel_partner_id} ChannelPartner string `json:"channelPartner,omitempty"` - // EventType: Type of event performed on the Channel Partner. + // EventType: Type of event which happened for the channel partner. // // Possible values: // "TYPE_UNSPECIFIED" - Default value. Does not display if there are no @@ -4070,7 +4092,7 @@ type GoogleCloudChannelV1alpha1CustomerEvent struct { // Customer: Resource name of the customer. Format: // accounts/{account_id}/customers/{customer_id} Customer string `json:"customer,omitempty"` - // EventType: Type of event which happened on the customer. + // EventType: Type of event which happened for the customer. // // Possible values: // "TYPE_UNSPECIFIED" - Not used. @@ -4258,7 +4280,7 @@ type GoogleCloudChannelV1alpha1EntitlementEvent struct { // Entitlement: Resource name of an entitlement of the form: // accounts/{account_id}/customers/{customer_id}/entitlements/{entitlement_id} Entitlement string `json:"entitlement,omitempty"` - // EventType: Type of event which happened on the entitlement. + // EventType: Type of event which happened for the entitlement. // // Possible values: // "TYPE_UNSPECIFIED" - Not used. @@ -4349,6 +4371,37 @@ func (s GoogleCloudChannelV1alpha1OperationMetadata) MarshalJSON() ([]byte, erro return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) } +// GoogleCloudChannelV1alpha1OpportunityEvent: Represents Pub/Sub message +// content describing opportunity updates. +type GoogleCloudChannelV1alpha1OpportunityEvent struct { + // EventType: Type of event which happened for the opportunity. + // + // Possible values: + // "TYPE_UNSPECIFIED" - Not used. + // "CREATED" - New opportunity created. + // "UPDATED" - Existing opportunity updated. + EventType string `json:"eventType,omitempty"` + // Opportunity: Resource name of the opportunity. Format: + // opportunities/{opportunity} + Opportunity string `json:"opportunity,omitempty"` + // ForceSendFields is a list of field names (e.g. "EventType") to + // unconditionally include in API requests. By default, fields with empty or + // default values are omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more + // details. + ForceSendFields []string `json:"-"` + // NullFields is a list of field names (e.g. "EventType") to include in API + // requests with the JSON null value. By default, fields with empty values are + // omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details. + NullFields []string `json:"-"` +} + +func (s GoogleCloudChannelV1alpha1OpportunityEvent) MarshalJSON() ([]byte, error) { + type NoMethod GoogleCloudChannelV1alpha1OpportunityEvent + return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) +} + // GoogleCloudChannelV1alpha1Parameter: Definition for extended entitlement // parameters. type GoogleCloudChannelV1alpha1Parameter struct { @@ -4663,6 +4716,9 @@ type GoogleCloudChannelV1alpha1SubscriberEvent struct { // EntitlementEvent: Entitlement event sent as part of Pub/Sub event to // partners. EntitlementEvent *GoogleCloudChannelV1alpha1EntitlementEvent `json:"entitlementEvent,omitempty"` + // OpportunityEvent: Opportunity event sent as part of Pub/Sub event to + // partners/integrators. + OpportunityEvent *GoogleCloudChannelV1alpha1OpportunityEvent `json:"opportunityEvent,omitempty"` // ForceSendFields is a list of field names (e.g. "ChannelPartnerEvent") to // unconditionally include in API requests. By default, fields with empty or // default values are omitted from API requests. See @@ -5004,9 +5060,10 @@ func (s GoogleTypeDateTime) MarshalJSON() ([]byte, error) { // GoogleTypeDecimal: A representation of a decimal value, such as 2.5. Clients // may convert values into language-native decimal formats, such as Java's -// BigDecimal or Python's decimal.Decimal. [BigDecimal]: -// https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/math/BigDecimal.html -// [decimal.Decimal]: https://docs.python.org/3/library/decimal.html +// BigDecimal +// (https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/math/BigDecimal.html) +// or Python's decimal.Decimal +// (https://docs.python.org/3/library/decimal.html). type GoogleTypeDecimal struct { // Value: The decimal value, as a string. The string representation consists of // an optional sign, `+` (`U+002B`) or `-` (`U+002D`), followed by a sequence diff --git a/discoveryengine/v1/discoveryengine-api.json b/discoveryengine/v1/discoveryengine-api.json index 2a8a246bd49..1533b45d8a0 100644 --- a/discoveryengine/v1/discoveryengine-api.json +++ b/discoveryengine/v1/discoveryengine-api.json @@ -6090,7 +6090,7 @@ } } }, - "revision": "20241030", + "revision": "20241031", "rootUrl": "https://discoveryengine.googleapis.com/", "schemas": { "GoogleApiDistribution": { @@ -7756,7 +7756,14 @@ "citedChunks": { "description": "List of facts cited across all claims in the answer candidate. These are derived from the facts supplied in the request.", "items": { - "$ref": "GoogleCloudDiscoveryengineV1CheckGroundingResponseFactChunk" + "$ref": "GoogleCloudDiscoveryengineV1FactChunk" + }, + "type": "array" + }, + "citedFacts": { + "description": "List of facts cited across all claims in the answer candidate. These are derived from the facts supplied in the request.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1CheckGroundingResponseCheckGroundingFactChunk" }, "type": "array" }, @@ -7775,6 +7782,17 @@ }, "type": "object" }, + "GoogleCloudDiscoveryengineV1CheckGroundingResponseCheckGroundingFactChunk": { + "description": "Fact chunk for grounding check.", + "id": "GoogleCloudDiscoveryengineV1CheckGroundingResponseCheckGroundingFactChunk", + "properties": { + "chunkText": { + "description": "Text content of the fact chunk. Can be at most 10K characters long.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDiscoveryengineV1CheckGroundingResponseClaim": { "description": "Text and citation info for a claim in the answer candidate.", "id": "GoogleCloudDiscoveryengineV1CheckGroundingResponseClaim", @@ -7808,21 +7826,6 @@ }, "type": "object" }, - "GoogleCloudDiscoveryengineV1CheckGroundingResponseFactChunk": { - "description": "Fact chunk for grounding check.", - "id": "GoogleCloudDiscoveryengineV1CheckGroundingResponseFactChunk", - "properties": { - "chunkText": { - "description": "Text content of the fact chunk. Can be at most 10K characters long.", - "type": "string" - }, - "source": { - "description": "Source from which this fact chunk was retrieved. For a fact chunk retrieved from inline facts, this field will contain the index of the specific fact from which this chunk was retrieved.", - "type": "string" - } - }, - "type": "object" - }, "GoogleCloudDiscoveryengineV1CheckGroundingSpec": { "description": "Specification for the grounding check.", "id": "GoogleCloudDiscoveryengineV1CheckGroundingSpec", @@ -9352,6 +9355,107 @@ }, "type": "object" }, + "GoogleCloudDiscoveryengineV1FactChunk": { + "description": "Fact Chunk.", + "id": "GoogleCloudDiscoveryengineV1FactChunk", + "properties": { + "chunkText": { + "description": "Text content of the fact chunk. Can be at most 10K characters long.", + "type": "string" + }, + "index": { + "description": "The index of this chunk. Currently, only used for the streaming mode.", + "format": "int32", + "type": "integer" + }, + "source": { + "description": "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.", + "type": "string" + }, + "sourceMetadata": { + "additionalProperties": { + "type": "string" + }, + "description": "More fine-grained information for the source reference.", + "type": "object" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1Feedback": { + "description": "Information about the user feedback. This information will be used for logging and metrics purpose.", + "id": "GoogleCloudDiscoveryengineV1Feedback", + "properties": { + "comment": { + "description": "Optional. The additional user comment of the feedback if user gives a thumb down.", + "type": "string" + }, + "conversationInfo": { + "$ref": "GoogleCloudDiscoveryengineV1FeedbackConversationInfo", + "description": "The related conversation information when user gives feedback." + }, + "feedbackType": { + "description": "Required. Indicate whether the user gives a positive or negative feedback. If the user gives a negative feedback, there might be more feedback details.", + "enum": [ + "FEEDBACK_TYPE_UNSPECIFIED", + "LIKE", + "DISLIKE" + ], + "enumDescriptions": [ + "Unspecified feedback type.", + "The user gives a positive feedback.", + "The user gives a negative feedback." + ], + "type": "string" + }, + "llmModelVersion": { + "description": "The version of the LLM model that was used to generate the response.", + "type": "string" + }, + "reasons": { + "description": "Optional. The reason if user gives a thumb down.", + "items": { + "enum": [ + "REASON_UNSPECIFIED", + "INACCURATE_RESPONSE", + "NOT_RELEVANT", + "INCOMPREHENSIVE", + "OFFENSIVE_OR_UNSAFE", + "BAD_CIATION", + "FORMAT_AND_STYLES" + ], + "enumDescriptions": [ + "Unspecified reason.", + "The response is inaccurate.", + "The response is not relevant.", + "The response is incomprehensive.", + "The response is offensive or unsafe.", + "The response is not well-associated with the query.", + "The response is not well-formatted." + ], + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1FeedbackConversationInfo": { + "description": "The conversation information such as the question index and session name.", + "id": "GoogleCloudDiscoveryengineV1FeedbackConversationInfo", + "properties": { + "questionIndex": { + "description": "The index of the user input within the conversation messages.", + "format": "int32", + "type": "integer" + }, + "session": { + "description": "Name of the newly generated or continued session.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDiscoveryengineV1FetchDomainVerificationStatusResponse": { "description": "Response message for SiteSearchEngineService.FetchDomainVerificationStatus method.", "id": "GoogleCloudDiscoveryengineV1FetchDomainVerificationStatusResponse", @@ -10087,6 +10191,13 @@ "description": "The display name of the panel.", "type": "string" }, + "documents": { + "description": "Optional. The document IDs associated with this panel.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1DocumentInfo" + }, + "type": "array" + }, "panelId": { "description": "Required. The panel ID.", "type": "string" @@ -12057,6 +12168,10 @@ "description": "Required. User event type. Allowed values are: Generic values: * `search`: Search for Documents. * `view-item`: Detailed page view of a Document. * `view-item-list`: View of a panel or ordered list of Documents. * `view-home-page`: View of the home page. * `view-category-page`: View of a category page, e.g. Home \u003e Men \u003e Jeans * `add-feedback`: Add a user feedback. Retail-related values: * `add-to-cart`: Add an item(s) to cart, e.g. in Retail online shopping * `purchase`: Purchase an item(s) Media-related values: * `media-play`: Start/resume watching a video, playing a song, etc. * `media-complete`: Finished or stopped midway through a video, song, etc.", "type": "string" }, + "feedback": { + "$ref": "GoogleCloudDiscoveryengineV1Feedback", + "description": "Optional. This field is optional except for the `add-feedback` event types." + }, "filter": { "description": "The filter syntax consists of an expression language for constructing a predicate from one or more fields of the documents being filtered. One example is for `search` events, the associated SearchRequest may contain a filter expression in SearchRequest.filter conforming to https://google.aip.dev/160#filtering. Similarly, for `view-item-list` events that are generated from a RecommendRequest, this field may be populated directly from RecommendRequest.filter conforming to https://google.aip.dev/160#filtering. The value must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.", "type": "string" @@ -12073,6 +12188,13 @@ "$ref": "GoogleCloudDiscoveryengineV1PanelInfo", "description": "Panel metadata associated with this user event." }, + "panels": { + "description": "Optional. List of panels associated with this event. Used for page-level impression data.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1PanelInfo" + }, + "type": "array" + }, "promotionIds": { "description": "The promotion IDs if this is an event associated with promotions. Currently, this field is restricted to at most one ID.", "items": { diff --git a/discoveryengine/v1/discoveryengine-gen.go b/discoveryengine/v1/discoveryengine-gen.go index f25672fae8f..1fe1f51b947 100644 --- a/discoveryengine/v1/discoveryengine-gen.go +++ b/discoveryengine/v1/discoveryengine-gen.go @@ -3304,7 +3304,10 @@ func (s GoogleCloudDiscoveryengineV1CheckGroundingRequest) MarshalJSON() ([]byte type GoogleCloudDiscoveryengineV1CheckGroundingResponse struct { // CitedChunks: List of facts cited across all claims in the answer candidate. // These are derived from the facts supplied in the request. - CitedChunks []*GoogleCloudDiscoveryengineV1CheckGroundingResponseFactChunk `json:"citedChunks,omitempty"` + CitedChunks []*GoogleCloudDiscoveryengineV1FactChunk `json:"citedChunks,omitempty"` + // CitedFacts: List of facts cited across all claims in the answer candidate. + // These are derived from the facts supplied in the request. + CitedFacts []*GoogleCloudDiscoveryengineV1CheckGroundingResponseCheckGroundingFactChunk `json:"citedFacts,omitempty"` // Claims: Claim texts and citation info across all claims in the answer // candidate. Claims []*GoogleCloudDiscoveryengineV1CheckGroundingResponseClaim `json:"claims,omitempty"` @@ -3347,6 +3350,30 @@ func (s *GoogleCloudDiscoveryengineV1CheckGroundingResponse) UnmarshalJSON(data return nil } +// GoogleCloudDiscoveryengineV1CheckGroundingResponseCheckGroundingFactChunk: +// Fact chunk for grounding check. +type GoogleCloudDiscoveryengineV1CheckGroundingResponseCheckGroundingFactChunk struct { + // ChunkText: Text content of the fact chunk. Can be at most 10K characters + // long. + ChunkText string `json:"chunkText,omitempty"` + // ForceSendFields is a list of field names (e.g. "ChunkText") to + // unconditionally include in API requests. By default, fields with empty or + // default values are omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more + // details. + ForceSendFields []string `json:"-"` + // NullFields is a list of field names (e.g. "ChunkText") to include in API + // requests with the JSON null value. By default, fields with empty values are + // omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details. + NullFields []string `json:"-"` +} + +func (s GoogleCloudDiscoveryengineV1CheckGroundingResponseCheckGroundingFactChunk) MarshalJSON() ([]byte, error) { + type NoMethod GoogleCloudDiscoveryengineV1CheckGroundingResponseCheckGroundingFactChunk + return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) +} + // GoogleCloudDiscoveryengineV1CheckGroundingResponseClaim: Text and citation // info for a claim in the answer candidate. type GoogleCloudDiscoveryengineV1CheckGroundingResponseClaim struct { @@ -3389,34 +3416,6 @@ func (s GoogleCloudDiscoveryengineV1CheckGroundingResponseClaim) MarshalJSON() ( return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) } -// GoogleCloudDiscoveryengineV1CheckGroundingResponseFactChunk: Fact chunk for -// grounding check. -type GoogleCloudDiscoveryengineV1CheckGroundingResponseFactChunk struct { - // ChunkText: Text content of the fact chunk. Can be at most 10K characters - // long. - ChunkText string `json:"chunkText,omitempty"` - // Source: Source from which this fact chunk was retrieved. For a fact chunk - // retrieved from inline facts, this field will contain the index of the - // specific fact from which this chunk was retrieved. - Source string `json:"source,omitempty"` - // ForceSendFields is a list of field names (e.g. "ChunkText") to - // unconditionally include in API requests. By default, fields with empty or - // default values are omitted from API requests. See - // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more - // details. - ForceSendFields []string `json:"-"` - // NullFields is a list of field names (e.g. "ChunkText") to include in API - // requests with the JSON null value. By default, fields with empty values are - // omitted from API requests. See - // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details. - NullFields []string `json:"-"` -} - -func (s GoogleCloudDiscoveryengineV1CheckGroundingResponseFactChunk) MarshalJSON() ([]byte, error) { - type NoMethod GoogleCloudDiscoveryengineV1CheckGroundingResponseFactChunk - return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) -} - // GoogleCloudDiscoveryengineV1CheckGroundingSpec: Specification for the // grounding check. type GoogleCloudDiscoveryengineV1CheckGroundingSpec struct { @@ -5476,6 +5475,112 @@ func (s GoogleCloudDiscoveryengineV1EngineSearchEngineConfig) MarshalJSON() ([]b return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) } +// GoogleCloudDiscoveryengineV1FactChunk: Fact Chunk. +type GoogleCloudDiscoveryengineV1FactChunk struct { + // ChunkText: Text content of the fact chunk. Can be at most 10K characters + // long. + ChunkText string `json:"chunkText,omitempty"` + // Index: The index of this chunk. Currently, only used for the streaming mode. + Index int64 `json:"index,omitempty"` + // Source: 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. + Source string `json:"source,omitempty"` + // SourceMetadata: More fine-grained information for the source reference. + SourceMetadata map[string]string `json:"sourceMetadata,omitempty"` + // ForceSendFields is a list of field names (e.g. "ChunkText") to + // unconditionally include in API requests. By default, fields with empty or + // default values are omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more + // details. + ForceSendFields []string `json:"-"` + // NullFields is a list of field names (e.g. "ChunkText") to include in API + // requests with the JSON null value. By default, fields with empty values are + // omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details. + NullFields []string `json:"-"` +} + +func (s GoogleCloudDiscoveryengineV1FactChunk) MarshalJSON() ([]byte, error) { + type NoMethod GoogleCloudDiscoveryengineV1FactChunk + return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) +} + +// GoogleCloudDiscoveryengineV1Feedback: Information about the user feedback. +// This information will be used for logging and metrics purpose. +type GoogleCloudDiscoveryengineV1Feedback struct { + // Comment: Optional. The additional user comment of the feedback if user gives + // a thumb down. + Comment string `json:"comment,omitempty"` + // ConversationInfo: The related conversation information when user gives + // feedback. + ConversationInfo *GoogleCloudDiscoveryengineV1FeedbackConversationInfo `json:"conversationInfo,omitempty"` + // FeedbackType: Required. Indicate whether the user gives a positive or + // negative feedback. If the user gives a negative feedback, there might be + // more feedback details. + // + // Possible values: + // "FEEDBACK_TYPE_UNSPECIFIED" - Unspecified feedback type. + // "LIKE" - The user gives a positive feedback. + // "DISLIKE" - The user gives a negative feedback. + FeedbackType string `json:"feedbackType,omitempty"` + // LlmModelVersion: The version of the LLM model that was used to generate the + // response. + LlmModelVersion string `json:"llmModelVersion,omitempty"` + // Reasons: Optional. The reason if user gives a thumb down. + // + // Possible values: + // "REASON_UNSPECIFIED" - Unspecified reason. + // "INACCURATE_RESPONSE" - The response is inaccurate. + // "NOT_RELEVANT" - The response is not relevant. + // "INCOMPREHENSIVE" - The response is incomprehensive. + // "OFFENSIVE_OR_UNSAFE" - The response is offensive or unsafe. + // "BAD_CIATION" - The response is not well-associated with the query. + // "FORMAT_AND_STYLES" - The response is not well-formatted. + Reasons []string `json:"reasons,omitempty"` + // ForceSendFields is a list of field names (e.g. "Comment") to unconditionally + // include in API requests. By default, fields with empty or default values are + // omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more + // details. + ForceSendFields []string `json:"-"` + // NullFields is a list of field names (e.g. "Comment") to include in API + // requests with the JSON null value. By default, fields with empty values are + // omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details. + NullFields []string `json:"-"` +} + +func (s GoogleCloudDiscoveryengineV1Feedback) MarshalJSON() ([]byte, error) { + type NoMethod GoogleCloudDiscoveryengineV1Feedback + return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) +} + +// GoogleCloudDiscoveryengineV1FeedbackConversationInfo: The conversation +// information such as the question index and session name. +type GoogleCloudDiscoveryengineV1FeedbackConversationInfo struct { + // QuestionIndex: The index of the user input within the conversation messages. + QuestionIndex int64 `json:"questionIndex,omitempty"` + // Session: Name of the newly generated or continued session. + Session string `json:"session,omitempty"` + // ForceSendFields is a list of field names (e.g. "QuestionIndex") to + // unconditionally include in API requests. By default, fields with empty or + // default values are omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more + // details. + ForceSendFields []string `json:"-"` + // NullFields is a list of field names (e.g. "QuestionIndex") to include in API + // requests with the JSON null value. By default, fields with empty values are + // omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details. + NullFields []string `json:"-"` +} + +func (s GoogleCloudDiscoveryengineV1FeedbackConversationInfo) MarshalJSON() ([]byte, error) { + type NoMethod GoogleCloudDiscoveryengineV1FeedbackConversationInfo + return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) +} + // GoogleCloudDiscoveryengineV1FetchDomainVerificationStatusResponse: Response // message for SiteSearchEngineService.FetchDomainVerificationStatus method. type GoogleCloudDiscoveryengineV1FetchDomainVerificationStatusResponse struct { @@ -6586,6 +6691,8 @@ func (s GoogleCloudDiscoveryengineV1PageInfo) MarshalJSON() ([]byte, error) { type GoogleCloudDiscoveryengineV1PanelInfo struct { // DisplayName: The display name of the panel. DisplayName string `json:"displayName,omitempty"` + // Documents: Optional. The document IDs associated with this panel. + Documents []*GoogleCloudDiscoveryengineV1DocumentInfo `json:"documents,omitempty"` // PanelId: Required. The panel ID. PanelId string `json:"panelId,omitempty"` // PanelPosition: The ordered position of the panel, if shown to the user with @@ -9607,6 +9714,9 @@ type GoogleCloudDiscoveryengineV1UserEvent struct { // a song, etc. * `media-complete`: Finished or stopped midway through a video, // song, etc. EventType string `json:"eventType,omitempty"` + // Feedback: Optional. This field is optional except for the `add-feedback` + // event types. + Feedback *GoogleCloudDiscoveryengineV1Feedback `json:"feedback,omitempty"` // Filter: The filter syntax consists of an expression language for // constructing a predicate from one or more fields of the documents being // filtered. One example is for `search` events, the associated SearchRequest @@ -9625,6 +9735,9 @@ type GoogleCloudDiscoveryengineV1UserEvent struct { PageInfo *GoogleCloudDiscoveryengineV1PageInfo `json:"pageInfo,omitempty"` // Panel: Panel metadata associated with this user event. Panel *GoogleCloudDiscoveryengineV1PanelInfo `json:"panel,omitempty"` + // Panels: Optional. List of panels associated with this event. Used for + // page-level impression data. + Panels []*GoogleCloudDiscoveryengineV1PanelInfo `json:"panels,omitempty"` // PromotionIds: The promotion IDs if this is an event associated with // promotions. Currently, this field is restricted to at most one ID. PromotionIds []string `json:"promotionIds,omitempty"` diff --git a/discoveryengine/v1alpha/discoveryengine-api.json b/discoveryengine/v1alpha/discoveryengine-api.json index 5977dba3d4b..1ca38c415ef 100644 --- a/discoveryengine/v1alpha/discoveryengine-api.json +++ b/discoveryengine/v1alpha/discoveryengine-api.json @@ -8007,7 +8007,7 @@ } } }, - "revision": "20241030", + "revision": "20241031", "rootUrl": "https://discoveryengine.googleapis.com/", "schemas": { "GoogleApiDistribution": { @@ -11571,7 +11571,14 @@ "citedChunks": { "description": "List of facts cited across all claims in the answer candidate. These are derived from the facts supplied in the request.", "items": { - "$ref": "GoogleCloudDiscoveryengineV1alphaCheckGroundingResponseFactChunk" + "$ref": "GoogleCloudDiscoveryengineV1alphaFactChunk" + }, + "type": "array" + }, + "citedFacts": { + "description": "List of facts cited across all claims in the answer candidate. These are derived from the facts supplied in the request.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1alphaCheckGroundingResponseCheckGroundingFactChunk" }, "type": "array" }, @@ -11590,6 +11597,17 @@ }, "type": "object" }, + "GoogleCloudDiscoveryengineV1alphaCheckGroundingResponseCheckGroundingFactChunk": { + "description": "Fact chunk for grounding check.", + "id": "GoogleCloudDiscoveryengineV1alphaCheckGroundingResponseCheckGroundingFactChunk", + "properties": { + "chunkText": { + "description": "Text content of the fact chunk. Can be at most 10K characters long.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDiscoveryengineV1alphaCheckGroundingResponseClaim": { "description": "Text and citation info for a claim in the answer candidate.", "id": "GoogleCloudDiscoveryengineV1alphaCheckGroundingResponseClaim", @@ -11623,21 +11641,6 @@ }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaCheckGroundingResponseFactChunk": { - "description": "Fact chunk for grounding check.", - "id": "GoogleCloudDiscoveryengineV1alphaCheckGroundingResponseFactChunk", - "properties": { - "chunkText": { - "description": "Text content of the fact chunk. Can be at most 10K characters long.", - "type": "string" - }, - "source": { - "description": "Source from which this fact chunk was retrieved. For a fact chunk retrieved from inline facts, this field will contain the index of the specific fact from which this chunk was retrieved.", - "type": "string" - } - }, - "type": "object" - }, "GoogleCloudDiscoveryengineV1alphaCheckGroundingSpec": { "description": "Specification for the grounding check.", "id": "GoogleCloudDiscoveryengineV1alphaCheckGroundingSpec", @@ -13719,6 +13722,107 @@ }, "type": "object" }, + "GoogleCloudDiscoveryengineV1alphaFactChunk": { + "description": "Fact Chunk.", + "id": "GoogleCloudDiscoveryengineV1alphaFactChunk", + "properties": { + "chunkText": { + "description": "Text content of the fact chunk. Can be at most 10K characters long.", + "type": "string" + }, + "index": { + "description": "The index of this chunk. Currently, only used for the streaming mode.", + "format": "int32", + "type": "integer" + }, + "source": { + "description": "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.", + "type": "string" + }, + "sourceMetadata": { + "additionalProperties": { + "type": "string" + }, + "description": "More fine-grained information for the source reference.", + "type": "object" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1alphaFeedback": { + "description": "Information about the user feedback. This information will be used for logging and metrics purpose.", + "id": "GoogleCloudDiscoveryengineV1alphaFeedback", + "properties": { + "comment": { + "description": "Optional. The additional user comment of the feedback if user gives a thumb down.", + "type": "string" + }, + "conversationInfo": { + "$ref": "GoogleCloudDiscoveryengineV1alphaFeedbackConversationInfo", + "description": "The related conversation information when user gives feedback." + }, + "feedbackType": { + "description": "Required. Indicate whether the user gives a positive or negative feedback. If the user gives a negative feedback, there might be more feedback details.", + "enum": [ + "FEEDBACK_TYPE_UNSPECIFIED", + "LIKE", + "DISLIKE" + ], + "enumDescriptions": [ + "Unspecified feedback type.", + "The user gives a positive feedback.", + "The user gives a negative feedback." + ], + "type": "string" + }, + "llmModelVersion": { + "description": "The version of the LLM model that was used to generate the response.", + "type": "string" + }, + "reasons": { + "description": "Optional. The reason if user gives a thumb down.", + "items": { + "enum": [ + "REASON_UNSPECIFIED", + "INACCURATE_RESPONSE", + "NOT_RELEVANT", + "INCOMPREHENSIVE", + "OFFENSIVE_OR_UNSAFE", + "BAD_CIATION", + "FORMAT_AND_STYLES" + ], + "enumDescriptions": [ + "Unspecified reason.", + "The response is inaccurate.", + "The response is not relevant.", + "The response is incomprehensive.", + "The response is offensive or unsafe.", + "The response is not well-associated with the query.", + "The response is not well-formatted." + ], + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1alphaFeedbackConversationInfo": { + "description": "The conversation information such as the question index and session name.", + "id": "GoogleCloudDiscoveryengineV1alphaFeedbackConversationInfo", + "properties": { + "questionIndex": { + "description": "The index of the user input within the conversation messages.", + "format": "int32", + "type": "integer" + }, + "session": { + "description": "Name of the newly generated or continued session.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDiscoveryengineV1alphaFetchDomainVerificationStatusResponse": { "description": "Response message for SiteSearchEngineService.FetchDomainVerificationStatus method.", "id": "GoogleCloudDiscoveryengineV1alphaFetchDomainVerificationStatusResponse", @@ -15032,6 +15136,13 @@ "description": "The display name of the panel.", "type": "string" }, + "documents": { + "description": "Optional. The document IDs associated with this panel.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1alphaDocumentInfo" + }, + "type": "array" + }, "panelId": { "description": "Required. The panel ID.", "type": "string" @@ -18239,6 +18350,10 @@ "description": "Required. User event type. Allowed values are: Generic values: * `search`: Search for Documents. * `view-item`: Detailed page view of a Document. * `view-item-list`: View of a panel or ordered list of Documents. * `view-home-page`: View of the home page. * `view-category-page`: View of a category page, e.g. Home \u003e Men \u003e Jeans * `add-feedback`: Add a user feedback. Retail-related values: * `add-to-cart`: Add an item(s) to cart, e.g. in Retail online shopping * `purchase`: Purchase an item(s) Media-related values: * `media-play`: Start/resume watching a video, playing a song, etc. * `media-complete`: Finished or stopped midway through a video, song, etc.", "type": "string" }, + "feedback": { + "$ref": "GoogleCloudDiscoveryengineV1alphaFeedback", + "description": "Optional. This field is optional except for the `add-feedback` event types." + }, "filter": { "description": "The filter syntax consists of an expression language for constructing a predicate from one or more fields of the documents being filtered. One example is for `search` events, the associated SearchRequest may contain a filter expression in SearchRequest.filter conforming to https://google.aip.dev/160#filtering. Similarly, for `view-item-list` events that are generated from a RecommendRequest, this field may be populated directly from RecommendRequest.filter conforming to https://google.aip.dev/160#filtering. The value must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.", "type": "string" @@ -18255,6 +18370,13 @@ "$ref": "GoogleCloudDiscoveryengineV1alphaPanelInfo", "description": "Panel metadata associated with this user event." }, + "panels": { + "description": "Optional. List of panels associated with this event. Used for page-level impression data.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1alphaPanelInfo" + }, + "type": "array" + }, "promotionIds": { "description": "The promotion IDs if this is an event associated with promotions. Currently, this field is restricted to at most one ID.", "items": { diff --git a/discoveryengine/v1alpha/discoveryengine-gen.go b/discoveryengine/v1alpha/discoveryengine-gen.go index 79ec624ba0d..7db15980c23 100644 --- a/discoveryengine/v1alpha/discoveryengine-gen.go +++ b/discoveryengine/v1alpha/discoveryengine-gen.go @@ -6002,7 +6002,10 @@ func (s GoogleCloudDiscoveryengineV1alphaCheckGroundingRequest) MarshalJSON() ([ type GoogleCloudDiscoveryengineV1alphaCheckGroundingResponse struct { // CitedChunks: List of facts cited across all claims in the answer candidate. // These are derived from the facts supplied in the request. - CitedChunks []*GoogleCloudDiscoveryengineV1alphaCheckGroundingResponseFactChunk `json:"citedChunks,omitempty"` + CitedChunks []*GoogleCloudDiscoveryengineV1alphaFactChunk `json:"citedChunks,omitempty"` + // CitedFacts: List of facts cited across all claims in the answer candidate. + // These are derived from the facts supplied in the request. + CitedFacts []*GoogleCloudDiscoveryengineV1alphaCheckGroundingResponseCheckGroundingFactChunk `json:"citedFacts,omitempty"` // Claims: Claim texts and citation info across all claims in the answer // candidate. Claims []*GoogleCloudDiscoveryengineV1alphaCheckGroundingResponseClaim `json:"claims,omitempty"` @@ -6045,6 +6048,30 @@ func (s *GoogleCloudDiscoveryengineV1alphaCheckGroundingResponse) UnmarshalJSON( return nil } +// GoogleCloudDiscoveryengineV1alphaCheckGroundingResponseCheckGroundingFactChun +// k: Fact chunk for grounding check. +type GoogleCloudDiscoveryengineV1alphaCheckGroundingResponseCheckGroundingFactChunk struct { + // ChunkText: Text content of the fact chunk. Can be at most 10K characters + // long. + ChunkText string `json:"chunkText,omitempty"` + // ForceSendFields is a list of field names (e.g. "ChunkText") to + // unconditionally include in API requests. By default, fields with empty or + // default values are omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more + // details. + ForceSendFields []string `json:"-"` + // NullFields is a list of field names (e.g. "ChunkText") to include in API + // requests with the JSON null value. By default, fields with empty values are + // omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details. + NullFields []string `json:"-"` +} + +func (s GoogleCloudDiscoveryengineV1alphaCheckGroundingResponseCheckGroundingFactChunk) MarshalJSON() ([]byte, error) { + type NoMethod GoogleCloudDiscoveryengineV1alphaCheckGroundingResponseCheckGroundingFactChunk + return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) +} + // GoogleCloudDiscoveryengineV1alphaCheckGroundingResponseClaim: Text and // citation info for a claim in the answer candidate. type GoogleCloudDiscoveryengineV1alphaCheckGroundingResponseClaim struct { @@ -6087,34 +6114,6 @@ func (s GoogleCloudDiscoveryengineV1alphaCheckGroundingResponseClaim) MarshalJSO return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) } -// GoogleCloudDiscoveryengineV1alphaCheckGroundingResponseFactChunk: Fact chunk -// for grounding check. -type GoogleCloudDiscoveryengineV1alphaCheckGroundingResponseFactChunk struct { - // ChunkText: Text content of the fact chunk. Can be at most 10K characters - // long. - ChunkText string `json:"chunkText,omitempty"` - // Source: Source from which this fact chunk was retrieved. For a fact chunk - // retrieved from inline facts, this field will contain the index of the - // specific fact from which this chunk was retrieved. - Source string `json:"source,omitempty"` - // ForceSendFields is a list of field names (e.g. "ChunkText") to - // unconditionally include in API requests. By default, fields with empty or - // default values are omitted from API requests. See - // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more - // details. - ForceSendFields []string `json:"-"` - // NullFields is a list of field names (e.g. "ChunkText") to include in API - // requests with the JSON null value. By default, fields with empty values are - // omitted from API requests. See - // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details. - NullFields []string `json:"-"` -} - -func (s GoogleCloudDiscoveryengineV1alphaCheckGroundingResponseFactChunk) MarshalJSON() ([]byte, error) { - type NoMethod GoogleCloudDiscoveryengineV1alphaCheckGroundingResponseFactChunk - return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) -} - // GoogleCloudDiscoveryengineV1alphaCheckGroundingSpec: Specification for the // grounding check. type GoogleCloudDiscoveryengineV1alphaCheckGroundingSpec struct { @@ -9011,6 +9010,112 @@ func (s GoogleCloudDiscoveryengineV1alphaEvaluationEvaluationSpecQuerySetSpec) M return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) } +// GoogleCloudDiscoveryengineV1alphaFactChunk: Fact Chunk. +type GoogleCloudDiscoveryengineV1alphaFactChunk struct { + // ChunkText: Text content of the fact chunk. Can be at most 10K characters + // long. + ChunkText string `json:"chunkText,omitempty"` + // Index: The index of this chunk. Currently, only used for the streaming mode. + Index int64 `json:"index,omitempty"` + // Source: 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. + Source string `json:"source,omitempty"` + // SourceMetadata: More fine-grained information for the source reference. + SourceMetadata map[string]string `json:"sourceMetadata,omitempty"` + // ForceSendFields is a list of field names (e.g. "ChunkText") to + // unconditionally include in API requests. By default, fields with empty or + // default values are omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more + // details. + ForceSendFields []string `json:"-"` + // NullFields is a list of field names (e.g. "ChunkText") to include in API + // requests with the JSON null value. By default, fields with empty values are + // omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details. + NullFields []string `json:"-"` +} + +func (s GoogleCloudDiscoveryengineV1alphaFactChunk) MarshalJSON() ([]byte, error) { + type NoMethod GoogleCloudDiscoveryengineV1alphaFactChunk + return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) +} + +// GoogleCloudDiscoveryengineV1alphaFeedback: Information about the user +// feedback. This information will be used for logging and metrics purpose. +type GoogleCloudDiscoveryengineV1alphaFeedback struct { + // Comment: Optional. The additional user comment of the feedback if user gives + // a thumb down. + Comment string `json:"comment,omitempty"` + // ConversationInfo: The related conversation information when user gives + // feedback. + ConversationInfo *GoogleCloudDiscoveryengineV1alphaFeedbackConversationInfo `json:"conversationInfo,omitempty"` + // FeedbackType: Required. Indicate whether the user gives a positive or + // negative feedback. If the user gives a negative feedback, there might be + // more feedback details. + // + // Possible values: + // "FEEDBACK_TYPE_UNSPECIFIED" - Unspecified feedback type. + // "LIKE" - The user gives a positive feedback. + // "DISLIKE" - The user gives a negative feedback. + FeedbackType string `json:"feedbackType,omitempty"` + // LlmModelVersion: The version of the LLM model that was used to generate the + // response. + LlmModelVersion string `json:"llmModelVersion,omitempty"` + // Reasons: Optional. The reason if user gives a thumb down. + // + // Possible values: + // "REASON_UNSPECIFIED" - Unspecified reason. + // "INACCURATE_RESPONSE" - The response is inaccurate. + // "NOT_RELEVANT" - The response is not relevant. + // "INCOMPREHENSIVE" - The response is incomprehensive. + // "OFFENSIVE_OR_UNSAFE" - The response is offensive or unsafe. + // "BAD_CIATION" - The response is not well-associated with the query. + // "FORMAT_AND_STYLES" - The response is not well-formatted. + Reasons []string `json:"reasons,omitempty"` + // ForceSendFields is a list of field names (e.g. "Comment") to unconditionally + // include in API requests. By default, fields with empty or default values are + // omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more + // details. + ForceSendFields []string `json:"-"` + // NullFields is a list of field names (e.g. "Comment") to include in API + // requests with the JSON null value. By default, fields with empty values are + // omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details. + NullFields []string `json:"-"` +} + +func (s GoogleCloudDiscoveryengineV1alphaFeedback) MarshalJSON() ([]byte, error) { + type NoMethod GoogleCloudDiscoveryengineV1alphaFeedback + return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) +} + +// GoogleCloudDiscoveryengineV1alphaFeedbackConversationInfo: The conversation +// information such as the question index and session name. +type GoogleCloudDiscoveryengineV1alphaFeedbackConversationInfo struct { + // QuestionIndex: The index of the user input within the conversation messages. + QuestionIndex int64 `json:"questionIndex,omitempty"` + // Session: Name of the newly generated or continued session. + Session string `json:"session,omitempty"` + // ForceSendFields is a list of field names (e.g. "QuestionIndex") to + // unconditionally include in API requests. By default, fields with empty or + // default values are omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more + // details. + ForceSendFields []string `json:"-"` + // NullFields is a list of field names (e.g. "QuestionIndex") to include in API + // requests with the JSON null value. By default, fields with empty values are + // omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details. + NullFields []string `json:"-"` +} + +func (s GoogleCloudDiscoveryengineV1alphaFeedbackConversationInfo) MarshalJSON() ([]byte, error) { + type NoMethod GoogleCloudDiscoveryengineV1alphaFeedbackConversationInfo + return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) +} + // GoogleCloudDiscoveryengineV1alphaFetchDomainVerificationStatusResponse: // Response message for SiteSearchEngineService.FetchDomainVerificationStatus // method. @@ -10936,6 +11041,8 @@ func (s GoogleCloudDiscoveryengineV1alphaPageInfo) MarshalJSON() ([]byte, error) type GoogleCloudDiscoveryengineV1alphaPanelInfo struct { // DisplayName: The display name of the panel. DisplayName string `json:"displayName,omitempty"` + // Documents: Optional. The document IDs associated with this panel. + Documents []*GoogleCloudDiscoveryengineV1alphaDocumentInfo `json:"documents,omitempty"` // PanelId: Required. The panel ID. PanelId string `json:"panelId,omitempty"` // PanelPosition: The ordered position of the panel, if shown to the user with @@ -15659,6 +15766,9 @@ type GoogleCloudDiscoveryengineV1alphaUserEvent struct { // a song, etc. * `media-complete`: Finished or stopped midway through a video, // song, etc. EventType string `json:"eventType,omitempty"` + // Feedback: Optional. This field is optional except for the `add-feedback` + // event types. + Feedback *GoogleCloudDiscoveryengineV1alphaFeedback `json:"feedback,omitempty"` // Filter: The filter syntax consists of an expression language for // constructing a predicate from one or more fields of the documents being // filtered. One example is for `search` events, the associated SearchRequest @@ -15677,6 +15787,9 @@ type GoogleCloudDiscoveryengineV1alphaUserEvent struct { PageInfo *GoogleCloudDiscoveryengineV1alphaPageInfo `json:"pageInfo,omitempty"` // Panel: Panel metadata associated with this user event. Panel *GoogleCloudDiscoveryengineV1alphaPanelInfo `json:"panel,omitempty"` + // Panels: Optional. List of panels associated with this event. Used for + // page-level impression data. + Panels []*GoogleCloudDiscoveryengineV1alphaPanelInfo `json:"panels,omitempty"` // PromotionIds: The promotion IDs if this is an event associated with // promotions. Currently, this field is restricted to at most one ID. PromotionIds []string `json:"promotionIds,omitempty"` diff --git a/discoveryengine/v1beta/discoveryengine-api.json b/discoveryengine/v1beta/discoveryengine-api.json index b4fc215ea07..5010111d6d9 100644 --- a/discoveryengine/v1beta/discoveryengine-api.json +++ b/discoveryengine/v1beta/discoveryengine-api.json @@ -7205,7 +7205,7 @@ } } }, - "revision": "20241030", + "revision": "20241031", "rootUrl": "https://discoveryengine.googleapis.com/", "schemas": { "GoogleApiDistribution": { @@ -14775,7 +14775,14 @@ "citedChunks": { "description": "List of facts cited across all claims in the answer candidate. These are derived from the facts supplied in the request.", "items": { - "$ref": "GoogleCloudDiscoveryengineV1betaCheckGroundingResponseFactChunk" + "$ref": "GoogleCloudDiscoveryengineV1betaFactChunk" + }, + "type": "array" + }, + "citedFacts": { + "description": "List of facts cited across all claims in the answer candidate. These are derived from the facts supplied in the request.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1betaCheckGroundingResponseCheckGroundingFactChunk" }, "type": "array" }, @@ -14794,6 +14801,17 @@ }, "type": "object" }, + "GoogleCloudDiscoveryengineV1betaCheckGroundingResponseCheckGroundingFactChunk": { + "description": "Fact chunk for grounding check.", + "id": "GoogleCloudDiscoveryengineV1betaCheckGroundingResponseCheckGroundingFactChunk", + "properties": { + "chunkText": { + "description": "Text content of the fact chunk. Can be at most 10K characters long.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDiscoveryengineV1betaCheckGroundingResponseClaim": { "description": "Text and citation info for a claim in the answer candidate.", "id": "GoogleCloudDiscoveryengineV1betaCheckGroundingResponseClaim", @@ -14827,21 +14845,6 @@ }, "type": "object" }, - "GoogleCloudDiscoveryengineV1betaCheckGroundingResponseFactChunk": { - "description": "Fact chunk for grounding check.", - "id": "GoogleCloudDiscoveryengineV1betaCheckGroundingResponseFactChunk", - "properties": { - "chunkText": { - "description": "Text content of the fact chunk. Can be at most 10K characters long.", - "type": "string" - }, - "source": { - "description": "Source from which this fact chunk was retrieved. For a fact chunk retrieved from inline facts, this field will contain the index of the specific fact from which this chunk was retrieved.", - "type": "string" - } - }, - "type": "object" - }, "GoogleCloudDiscoveryengineV1betaCheckGroundingSpec": { "description": "Specification for the grounding check.", "id": "GoogleCloudDiscoveryengineV1betaCheckGroundingSpec", @@ -16542,6 +16545,107 @@ }, "type": "object" }, + "GoogleCloudDiscoveryengineV1betaFactChunk": { + "description": "Fact Chunk.", + "id": "GoogleCloudDiscoveryengineV1betaFactChunk", + "properties": { + "chunkText": { + "description": "Text content of the fact chunk. Can be at most 10K characters long.", + "type": "string" + }, + "index": { + "description": "The index of this chunk. Currently, only used for the streaming mode.", + "format": "int32", + "type": "integer" + }, + "source": { + "description": "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.", + "type": "string" + }, + "sourceMetadata": { + "additionalProperties": { + "type": "string" + }, + "description": "More fine-grained information for the source reference.", + "type": "object" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1betaFeedback": { + "description": "Information about the user feedback. This information will be used for logging and metrics purpose.", + "id": "GoogleCloudDiscoveryengineV1betaFeedback", + "properties": { + "comment": { + "description": "Optional. The additional user comment of the feedback if user gives a thumb down.", + "type": "string" + }, + "conversationInfo": { + "$ref": "GoogleCloudDiscoveryengineV1betaFeedbackConversationInfo", + "description": "The related conversation information when user gives feedback." + }, + "feedbackType": { + "description": "Required. Indicate whether the user gives a positive or negative feedback. If the user gives a negative feedback, there might be more feedback details.", + "enum": [ + "FEEDBACK_TYPE_UNSPECIFIED", + "LIKE", + "DISLIKE" + ], + "enumDescriptions": [ + "Unspecified feedback type.", + "The user gives a positive feedback.", + "The user gives a negative feedback." + ], + "type": "string" + }, + "llmModelVersion": { + "description": "The version of the LLM model that was used to generate the response.", + "type": "string" + }, + "reasons": { + "description": "Optional. The reason if user gives a thumb down.", + "items": { + "enum": [ + "REASON_UNSPECIFIED", + "INACCURATE_RESPONSE", + "NOT_RELEVANT", + "INCOMPREHENSIVE", + "OFFENSIVE_OR_UNSAFE", + "BAD_CIATION", + "FORMAT_AND_STYLES" + ], + "enumDescriptions": [ + "Unspecified reason.", + "The response is inaccurate.", + "The response is not relevant.", + "The response is incomprehensive.", + "The response is offensive or unsafe.", + "The response is not well-associated with the query.", + "The response is not well-formatted." + ], + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1betaFeedbackConversationInfo": { + "description": "The conversation information such as the question index and session name.", + "id": "GoogleCloudDiscoveryengineV1betaFeedbackConversationInfo", + "properties": { + "questionIndex": { + "description": "The index of the user input within the conversation messages.", + "format": "int32", + "type": "integer" + }, + "session": { + "description": "Name of the newly generated or continued session.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDiscoveryengineV1betaFetchDomainVerificationStatusResponse": { "description": "Response message for SiteSearchEngineService.FetchDomainVerificationStatus method.", "id": "GoogleCloudDiscoveryengineV1betaFetchDomainVerificationStatusResponse", @@ -17543,6 +17647,13 @@ "description": "The display name of the panel.", "type": "string" }, + "documents": { + "description": "Optional. The document IDs associated with this panel.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1betaDocumentInfo" + }, + "type": "array" + }, "panelId": { "description": "Required. The panel ID.", "type": "string" @@ -20289,6 +20400,10 @@ "description": "Required. User event type. Allowed values are: Generic values: * `search`: Search for Documents. * `view-item`: Detailed page view of a Document. * `view-item-list`: View of a panel or ordered list of Documents. * `view-home-page`: View of the home page. * `view-category-page`: View of a category page, e.g. Home \u003e Men \u003e Jeans * `add-feedback`: Add a user feedback. Retail-related values: * `add-to-cart`: Add an item(s) to cart, e.g. in Retail online shopping * `purchase`: Purchase an item(s) Media-related values: * `media-play`: Start/resume watching a video, playing a song, etc. * `media-complete`: Finished or stopped midway through a video, song, etc.", "type": "string" }, + "feedback": { + "$ref": "GoogleCloudDiscoveryengineV1betaFeedback", + "description": "Optional. This field is optional except for the `add-feedback` event types." + }, "filter": { "description": "The filter syntax consists of an expression language for constructing a predicate from one or more fields of the documents being filtered. One example is for `search` events, the associated SearchRequest may contain a filter expression in SearchRequest.filter conforming to https://google.aip.dev/160#filtering. Similarly, for `view-item-list` events that are generated from a RecommendRequest, this field may be populated directly from RecommendRequest.filter conforming to https://google.aip.dev/160#filtering. The value must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.", "type": "string" @@ -20305,6 +20420,13 @@ "$ref": "GoogleCloudDiscoveryengineV1betaPanelInfo", "description": "Panel metadata associated with this user event." }, + "panels": { + "description": "Optional. List of panels associated with this event. Used for page-level impression data.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1betaPanelInfo" + }, + "type": "array" + }, "promotionIds": { "description": "The promotion IDs if this is an event associated with promotions. Currently, this field is restricted to at most one ID.", "items": { diff --git a/discoveryengine/v1beta/discoveryengine-gen.go b/discoveryengine/v1beta/discoveryengine-gen.go index 52d8c35b164..a59adcb86a8 100644 --- a/discoveryengine/v1beta/discoveryengine-gen.go +++ b/discoveryengine/v1beta/discoveryengine-gen.go @@ -11425,7 +11425,10 @@ func (s GoogleCloudDiscoveryengineV1betaCheckGroundingRequest) MarshalJSON() ([] type GoogleCloudDiscoveryengineV1betaCheckGroundingResponse struct { // CitedChunks: List of facts cited across all claims in the answer candidate. // These are derived from the facts supplied in the request. - CitedChunks []*GoogleCloudDiscoveryengineV1betaCheckGroundingResponseFactChunk `json:"citedChunks,omitempty"` + CitedChunks []*GoogleCloudDiscoveryengineV1betaFactChunk `json:"citedChunks,omitempty"` + // CitedFacts: List of facts cited across all claims in the answer candidate. + // These are derived from the facts supplied in the request. + CitedFacts []*GoogleCloudDiscoveryengineV1betaCheckGroundingResponseCheckGroundingFactChunk `json:"citedFacts,omitempty"` // Claims: Claim texts and citation info across all claims in the answer // candidate. Claims []*GoogleCloudDiscoveryengineV1betaCheckGroundingResponseClaim `json:"claims,omitempty"` @@ -11468,6 +11471,30 @@ func (s *GoogleCloudDiscoveryengineV1betaCheckGroundingResponse) UnmarshalJSON(d return nil } +// GoogleCloudDiscoveryengineV1betaCheckGroundingResponseCheckGroundingFactChunk +// : Fact chunk for grounding check. +type GoogleCloudDiscoveryengineV1betaCheckGroundingResponseCheckGroundingFactChunk struct { + // ChunkText: Text content of the fact chunk. Can be at most 10K characters + // long. + ChunkText string `json:"chunkText,omitempty"` + // ForceSendFields is a list of field names (e.g. "ChunkText") to + // unconditionally include in API requests. By default, fields with empty or + // default values are omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more + // details. + ForceSendFields []string `json:"-"` + // NullFields is a list of field names (e.g. "ChunkText") to include in API + // requests with the JSON null value. By default, fields with empty values are + // omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details. + NullFields []string `json:"-"` +} + +func (s GoogleCloudDiscoveryengineV1betaCheckGroundingResponseCheckGroundingFactChunk) MarshalJSON() ([]byte, error) { + type NoMethod GoogleCloudDiscoveryengineV1betaCheckGroundingResponseCheckGroundingFactChunk + return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) +} + // GoogleCloudDiscoveryengineV1betaCheckGroundingResponseClaim: Text and // citation info for a claim in the answer candidate. type GoogleCloudDiscoveryengineV1betaCheckGroundingResponseClaim struct { @@ -11510,34 +11537,6 @@ func (s GoogleCloudDiscoveryengineV1betaCheckGroundingResponseClaim) MarshalJSON return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) } -// GoogleCloudDiscoveryengineV1betaCheckGroundingResponseFactChunk: Fact chunk -// for grounding check. -type GoogleCloudDiscoveryengineV1betaCheckGroundingResponseFactChunk struct { - // ChunkText: Text content of the fact chunk. Can be at most 10K characters - // long. - ChunkText string `json:"chunkText,omitempty"` - // Source: Source from which this fact chunk was retrieved. For a fact chunk - // retrieved from inline facts, this field will contain the index of the - // specific fact from which this chunk was retrieved. - Source string `json:"source,omitempty"` - // ForceSendFields is a list of field names (e.g. "ChunkText") to - // unconditionally include in API requests. By default, fields with empty or - // default values are omitted from API requests. See - // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more - // details. - ForceSendFields []string `json:"-"` - // NullFields is a list of field names (e.g. "ChunkText") to include in API - // requests with the JSON null value. By default, fields with empty values are - // omitted from API requests. See - // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details. - NullFields []string `json:"-"` -} - -func (s GoogleCloudDiscoveryengineV1betaCheckGroundingResponseFactChunk) MarshalJSON() ([]byte, error) { - type NoMethod GoogleCloudDiscoveryengineV1betaCheckGroundingResponseFactChunk - return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) -} - // GoogleCloudDiscoveryengineV1betaCheckGroundingSpec: Specification for the // grounding check. type GoogleCloudDiscoveryengineV1betaCheckGroundingSpec struct { @@ -13836,6 +13835,112 @@ func (s GoogleCloudDiscoveryengineV1betaEvaluationEvaluationSpecQuerySetSpec) Ma return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) } +// GoogleCloudDiscoveryengineV1betaFactChunk: Fact Chunk. +type GoogleCloudDiscoveryengineV1betaFactChunk struct { + // ChunkText: Text content of the fact chunk. Can be at most 10K characters + // long. + ChunkText string `json:"chunkText,omitempty"` + // Index: The index of this chunk. Currently, only used for the streaming mode. + Index int64 `json:"index,omitempty"` + // Source: 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. + Source string `json:"source,omitempty"` + // SourceMetadata: More fine-grained information for the source reference. + SourceMetadata map[string]string `json:"sourceMetadata,omitempty"` + // ForceSendFields is a list of field names (e.g. "ChunkText") to + // unconditionally include in API requests. By default, fields with empty or + // default values are omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more + // details. + ForceSendFields []string `json:"-"` + // NullFields is a list of field names (e.g. "ChunkText") to include in API + // requests with the JSON null value. By default, fields with empty values are + // omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details. + NullFields []string `json:"-"` +} + +func (s GoogleCloudDiscoveryengineV1betaFactChunk) MarshalJSON() ([]byte, error) { + type NoMethod GoogleCloudDiscoveryengineV1betaFactChunk + return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) +} + +// GoogleCloudDiscoveryengineV1betaFeedback: Information about the user +// feedback. This information will be used for logging and metrics purpose. +type GoogleCloudDiscoveryengineV1betaFeedback struct { + // Comment: Optional. The additional user comment of the feedback if user gives + // a thumb down. + Comment string `json:"comment,omitempty"` + // ConversationInfo: The related conversation information when user gives + // feedback. + ConversationInfo *GoogleCloudDiscoveryengineV1betaFeedbackConversationInfo `json:"conversationInfo,omitempty"` + // FeedbackType: Required. Indicate whether the user gives a positive or + // negative feedback. If the user gives a negative feedback, there might be + // more feedback details. + // + // Possible values: + // "FEEDBACK_TYPE_UNSPECIFIED" - Unspecified feedback type. + // "LIKE" - The user gives a positive feedback. + // "DISLIKE" - The user gives a negative feedback. + FeedbackType string `json:"feedbackType,omitempty"` + // LlmModelVersion: The version of the LLM model that was used to generate the + // response. + LlmModelVersion string `json:"llmModelVersion,omitempty"` + // Reasons: Optional. The reason if user gives a thumb down. + // + // Possible values: + // "REASON_UNSPECIFIED" - Unspecified reason. + // "INACCURATE_RESPONSE" - The response is inaccurate. + // "NOT_RELEVANT" - The response is not relevant. + // "INCOMPREHENSIVE" - The response is incomprehensive. + // "OFFENSIVE_OR_UNSAFE" - The response is offensive or unsafe. + // "BAD_CIATION" - The response is not well-associated with the query. + // "FORMAT_AND_STYLES" - The response is not well-formatted. + Reasons []string `json:"reasons,omitempty"` + // ForceSendFields is a list of field names (e.g. "Comment") to unconditionally + // include in API requests. By default, fields with empty or default values are + // omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more + // details. + ForceSendFields []string `json:"-"` + // NullFields is a list of field names (e.g. "Comment") to include in API + // requests with the JSON null value. By default, fields with empty values are + // omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details. + NullFields []string `json:"-"` +} + +func (s GoogleCloudDiscoveryengineV1betaFeedback) MarshalJSON() ([]byte, error) { + type NoMethod GoogleCloudDiscoveryengineV1betaFeedback + return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) +} + +// GoogleCloudDiscoveryengineV1betaFeedbackConversationInfo: The conversation +// information such as the question index and session name. +type GoogleCloudDiscoveryengineV1betaFeedbackConversationInfo struct { + // QuestionIndex: The index of the user input within the conversation messages. + QuestionIndex int64 `json:"questionIndex,omitempty"` + // Session: Name of the newly generated or continued session. + Session string `json:"session,omitempty"` + // ForceSendFields is a list of field names (e.g. "QuestionIndex") to + // unconditionally include in API requests. By default, fields with empty or + // default values are omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more + // details. + ForceSendFields []string `json:"-"` + // NullFields is a list of field names (e.g. "QuestionIndex") to include in API + // requests with the JSON null value. By default, fields with empty values are + // omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details. + NullFields []string `json:"-"` +} + +func (s GoogleCloudDiscoveryengineV1betaFeedbackConversationInfo) MarshalJSON() ([]byte, error) { + type NoMethod GoogleCloudDiscoveryengineV1betaFeedbackConversationInfo + return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) +} + // GoogleCloudDiscoveryengineV1betaFetchDomainVerificationStatusResponse: // Response message for SiteSearchEngineService.FetchDomainVerificationStatus // method. @@ -15347,6 +15452,8 @@ func (s GoogleCloudDiscoveryengineV1betaPageInfo) MarshalJSON() ([]byte, error) type GoogleCloudDiscoveryengineV1betaPanelInfo struct { // DisplayName: The display name of the panel. DisplayName string `json:"displayName,omitempty"` + // Documents: Optional. The document IDs associated with this panel. + Documents []*GoogleCloudDiscoveryengineV1betaDocumentInfo `json:"documents,omitempty"` // PanelId: Required. The panel ID. PanelId string `json:"panelId,omitempty"` // PanelPosition: The ordered position of the panel, if shown to the user with @@ -19459,6 +19566,9 @@ type GoogleCloudDiscoveryengineV1betaUserEvent struct { // a song, etc. * `media-complete`: Finished or stopped midway through a video, // song, etc. EventType string `json:"eventType,omitempty"` + // Feedback: Optional. This field is optional except for the `add-feedback` + // event types. + Feedback *GoogleCloudDiscoveryengineV1betaFeedback `json:"feedback,omitempty"` // Filter: The filter syntax consists of an expression language for // constructing a predicate from one or more fields of the documents being // filtered. One example is for `search` events, the associated SearchRequest @@ -19477,6 +19587,9 @@ type GoogleCloudDiscoveryengineV1betaUserEvent struct { PageInfo *GoogleCloudDiscoveryengineV1betaPageInfo `json:"pageInfo,omitempty"` // Panel: Panel metadata associated with this user event. Panel *GoogleCloudDiscoveryengineV1betaPanelInfo `json:"panel,omitempty"` + // Panels: Optional. List of panels associated with this event. Used for + // page-level impression data. + Panels []*GoogleCloudDiscoveryengineV1betaPanelInfo `json:"panels,omitempty"` // PromotionIds: The promotion IDs if this is an event associated with // promotions. Currently, this field is restricted to at most one ID. PromotionIds []string `json:"promotionIds,omitempty"` diff --git a/fcm/v1/fcm-api.json b/fcm/v1/fcm-api.json index 2690f298943..1af2183fe18 100644 --- a/fcm/v1/fcm-api.json +++ b/fcm/v1/fcm-api.json @@ -146,7 +146,7 @@ } } }, - "revision": "20240524", + "revision": "20241101", "rootUrl": "https://fcm.googleapis.com/", "schemas": { "AndroidConfig": { @@ -394,6 +394,10 @@ "description": "HTTP request headers defined in Apple Push Notification Service. Refer to [APNs request headers](https://developer.apple.com/documentation/usernotifications/setting_up_a_remote_notification_server/sending_notification_requests_to_apns) for supported headers such as `apns-expiration` and `apns-priority`. The backend sets a default value for `apns-expiration` of 30 days and a default value for `apns-priority` of 10 if not explicitly set.", "type": "object" }, + "liveActivityToken": { + "description": "Optional. [Apple Live Activity](https://developer.apple.com/design/human-interface-guidelines/live-activities) token to send updates to. This token can either be a push token or [push-to-start](https://developer.apple.com/documentation/activitykit/activity/pushtostarttoken) token from Apple.", + "type": "string" + }, "payload": { "additionalProperties": { "description": "Properties of the object.", diff --git a/fcm/v1/fcm-gen.go b/fcm/v1/fcm-gen.go index 152cb5b523f..a8a8972e965 100644 --- a/fcm/v1/fcm-gen.go +++ b/fcm/v1/fcm-gen.go @@ -482,6 +482,13 @@ type ApnsConfig struct { // backend sets a default value for `apns-expiration` of 30 days and a default // value for `apns-priority` of 10 if not explicitly set. Headers map[string]string `json:"headers,omitempty"` + // LiveActivityToken: Optional. Apple Live Activity + // (https://developer.apple.com/design/human-interface-guidelines/live-activities) + // token to send updates to. This token can either be a push token or + // push-to-start + // (https://developer.apple.com/documentation/activitykit/activity/pushtostarttoken) + // token from Apple. + LiveActivityToken string `json:"liveActivityToken,omitempty"` // Payload: APNs payload as a JSON object, including both `aps` dictionary and // custom payload. See Payload Key Reference // (https://developer.apple.com/documentation/usernotifications/setting_up_a_remote_notification_server/generating_a_remote_notification). diff --git a/firebaseml/v2beta/firebaseml-api.json b/firebaseml/v2beta/firebaseml-api.json index 8792b27dd29..53782e04b50 100644 --- a/firebaseml/v2beta/firebaseml-api.json +++ b/firebaseml/v2beta/firebaseml-api.json @@ -206,7 +206,7 @@ } } }, - "revision": "20241024", + "revision": "20241101", "rootUrl": "https://firebaseml.googleapis.com/", "schemas": { "Date": { @@ -1576,6 +1576,7 @@ "type": "integer" }, "vectorDistanceThreshold": { + "deprecated": true, "description": "Optional. Only return results with vector distance smaller than the threshold.", "format": "double", "type": "number" diff --git a/language/v1/language-api.json b/language/v1/language-api.json index 24f02722d77..16b76bb26df 100644 --- a/language/v1/language-api.json +++ b/language/v1/language-api.json @@ -246,7 +246,7 @@ } } }, - "revision": "20240929", + "revision": "20241103", "rootUrl": "https://language.googleapis.com/", "schemas": { "AnalyzeEntitiesRequest": { @@ -1790,7 +1790,7 @@ "type": "object" }, "InfraUsage": { - "description": "Infra Usage of billing metrics. Next ID: 6", + "description": "Infra Usage of billing metrics.", "id": "InfraUsage", "properties": { "cpuMetrics": { @@ -2889,7 +2889,6 @@ "type": "object" }, "XPSColumnSpecForecastingMetadata": { - "description": "=========================================================================== # The fields below are used exclusively for Forecasting.", "id": "XPSColumnSpecForecastingMetadata", "properties": { "columnType": { @@ -3382,11 +3381,11 @@ "type": "boolean" }, "outputGcrUri": { - "description": "The Google Contained Registry (GCR) path the exported files to be pushed to. This location is set if the exported format is DOCKDER.", + "description": "The Google Contained Registry path the exported files to be pushed to. This location is set if the exported format is DOCKDER.", "type": "string" }, "outputGcsUri": { - "description": "The Google Cloud Storage (GCS) directory where XPS will output the exported models and related files. Format: gs://bucket/directory", + "description": "The Google Cloud Storage directory where XPS will output the exported models and related files. Format: gs://bucket/directory", "type": "string" }, "tfJsFormat": { @@ -3402,7 +3401,7 @@ "type": "object" }, "XPSFileSpec": { - "description": "Spec of input and output files, on external file systems (CNS, GCS, etc).", + "description": "Spec of input and output files, on external file systems (for example, Colossus Namespace System or Google Cloud Storage).", "id": "XPSFileSpec", "properties": { "directoryPath": { @@ -3430,7 +3429,7 @@ "enumDescriptions": [ "", "", - "Internal format for parallel text data used by Google Translate. go/rkvtools", + "Internal format for parallel text data used by Google Translate.", "", "Only the lexicographically first file described by the file_spec contains the header line.", "" @@ -3559,7 +3558,7 @@ "id": "XPSImageExportModelSpec", "properties": { "exportModelOutputConfig": { - "description": "Contains the model format and internal location of the model files to be exported/downloaded. Use the GCS bucket name which is provided via TrainRequest.gcs_bucket_name to store the model files.", + "description": "Contains the model format and internal location of the model files to be exported/downloaded. Use the Google Cloud Storage bucket name which is provided via TrainRequest.gcs_bucket_name to store the model files.", "items": { "$ref": "XPSExportModelOutputConfig" }, @@ -3584,7 +3583,7 @@ "type": "array" }, "labelGcsUri": { - "description": "GCS uri of decoded labels file for model export 'dict.txt'.", + "description": "Google Cloud Storage URI of decoded labels file for model export 'dict.txt'.", "type": "string" }, "servingArtifact": { @@ -3592,11 +3591,11 @@ "description": "The default model binary file used for serving (e.g. online predict, batch predict) via public Cloud AI Platform API." }, "tfJsBinaryGcsPrefix": { - "description": "GCS uri prefix of Tensorflow JavaScript binary files 'groupX-shardXofX.bin' Deprecated.", + "description": "Google Cloud Storage URI prefix of Tensorflow JavaScript binary files 'groupX-shardXofX.bin'. Deprecated.", "type": "string" }, "tfLiteMetadataGcsUri": { - "description": "GCS uri of Tensorflow Lite metadata 'tflite_metadata.json'.", + "description": "Google Cloud Storage URI of Tensorflow Lite metadata 'tflite_metadata.json'.", "type": "string" } }, @@ -3688,7 +3687,7 @@ "", "The default partition.", "It has significantly lower replication than partition-0 and is located in the US only. It also has a larger model size limit and higher default RAM quota than partition-0. Customers with batch traffic, US-based traffic, or very large models should use this partition. Capacity in this partition is significantly cheaper than partition-0.", - "To be used by customers with Jellyfish-accelerated ops. See go/servomatic-jellyfish for details.", + "To be used by customers with Jellyfish-accelerated ops.", "The partition used by regionalized servomatic cloud regions.", "The partition used for loading models from custom storage." ], @@ -3948,14 +3947,13 @@ "type": "string" }, "gcsUri": { - "description": "The Google Cloud Storage (GCS) uri that stores the model binary files.", + "description": "The Google Cloud Storage URI that stores the model binary files.", "type": "string" } }, "type": "object" }, "XPSPreprocessResponse": { - "description": "Next ID: 8", "id": "XPSPreprocessResponse", "properties": { "outputExampleSet": { @@ -4129,7 +4127,7 @@ }, "XPSResponseExplanationSpec": { "deprecated": true, - "description": "Specification of Model explanation. Feature-based XAI in AutoML Vision ICN is deprecated, see b/288407203 for context.", + "description": "Specification of Model explanation. Feature-based XAI in AutoML Vision ICN is deprecated.", "id": "XPSResponseExplanationSpec", "properties": { "explanationType": { @@ -4585,7 +4583,7 @@ "type": "object" }, "XPSTablesDatasetMetadata": { - "description": "Metadata for a dataset used for AutoML Tables. Next ID: 6", + "description": "Metadata for a dataset used for AutoML Tables.", "id": "XPSTablesDatasetMetadata", "properties": { "mlUseColumnId": { @@ -4829,7 +4827,7 @@ "type": "object" }, "XPSTextComponentModel": { - "description": "Component model. Next ID: 10", + "description": "Component model.", "id": "XPSTextComponentModel", "properties": { "batchPredictionModelGcsUri": { @@ -4854,7 +4852,7 @@ "", "The default partition.", "It has significantly lower replication than partition-0 and is located in the US only. It also has a larger model size limit and higher default RAM quota than partition-0. Customers with batch traffic, US-based traffic, or very large models should use this partition. Capacity in this partition is significantly cheaper than partition-0.", - "To be used by customers with Jellyfish-accelerated ops. See go/servomatic-jellyfish for details.", + "To be used by customers with Jellyfish-accelerated ops.", "The partition used by regionalized servomatic cloud regions.", "The partition used for loading models from custom storage." ], @@ -4899,7 +4897,7 @@ "", "Model type for entity extraction.", "Model type for relationship extraction.", - "A composite model represents a set of component models that have to be used together for prediction. A composite model appears to be a single model to the model user. It may contain only one component model. Please refer to go/cnl-composite-models for more information.", + "A composite model represents a set of component models that have to be used together for prediction. A composite model appears to be a single model to the model user. It may contain only one component model.", "Model type used to train default, MA, and ATC models in a single batch worker pipeline.", "BERT pipeline needs a specific model type, since it uses a different TFX configuration compared with DEFAULT (despite sharing most of the code).", "Model type for EncPaLM." @@ -5134,7 +5132,6 @@ "type": "object" }, "XPSTrainResponse": { - "description": "Next ID: 18", "id": "XPSTrainResponse", "properties": { "deployedModelSizeBytes": { @@ -5411,7 +5408,7 @@ "id": "XPSVideoExportModelSpec", "properties": { "exportModelOutputConfig": { - "description": "Contains the model format and internal location of the model files to be exported/downloaded. Use the GCS bucket name which is provided via TrainRequest.gcs_bucket_name to store the model files.", + "description": "Contains the model format and internal location of the model files to be exported/downloaded. Use the Google Cloud Storage bucket name which is provided via TrainRequest.gcs_bucket_name to store the model files.", "items": { "$ref": "XPSExportModelOutputConfig" }, diff --git a/language/v1/language-gen.go b/language/v1/language-gen.go index 8305ee64bb4..8a9a89cfe45 100644 --- a/language/v1/language-gen.go +++ b/language/v1/language-gen.go @@ -1557,7 +1557,7 @@ func (s GpuMetric) MarshalJSON() ([]byte, error) { return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) } -// InfraUsage: Infra Usage of billing metrics. Next ID: 6 +// InfraUsage: Infra Usage of billing metrics. type InfraUsage struct { // CpuMetrics: Aggregated core metrics since requested start_time. CpuMetrics []*CpuMetric `json:"cpuMetrics,omitempty"` @@ -2590,9 +2590,6 @@ func (s XPSColumnSpecCorrelatedColumn) MarshalJSON() ([]byte, error) { return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) } -// XPSColumnSpecForecastingMetadata: -// =========================================================================== -// # The fields below are used exclusively for Forecasting. type XPSColumnSpecForecastingMetadata struct { // ColumnType: The type of the column for FORECASTING model training purposes. // @@ -3145,11 +3142,11 @@ type XPSExportModelOutputConfig struct { // ExportFirebaseAuxiliaryInfo: For any model and format: If true, will // additionally export FirebaseExportedModelInfo in a firebase.txt file. ExportFirebaseAuxiliaryInfo bool `json:"exportFirebaseAuxiliaryInfo,omitempty"` - // OutputGcrUri: The Google Contained Registry (GCR) path the exported files to - // be pushed to. This location is set if the exported format is DOCKDER. + // OutputGcrUri: The Google Contained Registry path the exported files to be + // pushed to. This location is set if the exported format is DOCKDER. OutputGcrUri string `json:"outputGcrUri,omitempty"` - // OutputGcsUri: The Google Cloud Storage (GCS) directory where XPS will output - // the exported models and related files. Format: gs://bucket/directory + // OutputGcsUri: The Google Cloud Storage directory where XPS will output the + // exported models and related files. Format: gs://bucket/directory OutputGcsUri string `json:"outputGcsUri,omitempty"` TfJsFormat *XPSTfJsFormat `json:"tfJsFormat,omitempty"` TfLiteFormat *XPSTfLiteFormat `json:"tfLiteFormat,omitempty"` @@ -3172,8 +3169,8 @@ func (s XPSExportModelOutputConfig) MarshalJSON() ([]byte, error) { return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) } -// XPSFileSpec: Spec of input and output files, on external file systems (CNS, -// GCS, etc). +// XPSFileSpec: Spec of input and output files, on external file systems (for +// example, Colossus Namespace System or Google Cloud Storage). type XPSFileSpec struct { // DirectoryPath: Deprecated. Use file_spec. DirectoryPath string `json:"directoryPath,omitempty"` @@ -3181,7 +3178,7 @@ type XPSFileSpec struct { // "FILE_FORMAT_UNKNOWN" // "FILE_FORMAT_SSTABLE" // "FILE_FORMAT_TRANSLATION_RKV" - Internal format for parallel text data - // used by Google Translate. go/rkvtools + // used by Google Translate. // "FILE_FORMAT_RECORDIO" // "FILE_FORMAT_RAW_CSV" - Only the lexicographically first file described by // the file_spec contains the header line. @@ -3370,8 +3367,9 @@ func (s XPSImageClassificationTrainResponse) MarshalJSON() ([]byte, error) { // requesting format. type XPSImageExportModelSpec struct { // ExportModelOutputConfig: Contains the model format and internal location of - // the model files to be exported/downloaded. Use the GCS bucket name which is - // provided via TrainRequest.gcs_bucket_name to store the model files. + // the model files to be exported/downloaded. Use the Google Cloud Storage + // bucket name which is provided via TrainRequest.gcs_bucket_name to store the + // model files. ExportModelOutputConfig []*XPSExportModelOutputConfig `json:"exportModelOutputConfig,omitempty"` // ForceSendFields is a list of field names (e.g. "ExportModelOutputConfig") to // unconditionally include in API requests. By default, fields with empty or @@ -3400,15 +3398,16 @@ type XPSImageModelArtifactSpec struct { // ExportArtifact: The model binary files in different formats for model // export. ExportArtifact []*XPSModelArtifactItem `json:"exportArtifact,omitempty"` - // LabelGcsUri: GCS uri of decoded labels file for model export 'dict.txt'. + // LabelGcsUri: Google Cloud Storage URI of decoded labels file for model + // export 'dict.txt'. LabelGcsUri string `json:"labelGcsUri,omitempty"` // ServingArtifact: The default model binary file used for serving (e.g. online // predict, batch predict) via public Cloud AI Platform API. ServingArtifact *XPSModelArtifactItem `json:"servingArtifact,omitempty"` - // TfJsBinaryGcsPrefix: GCS uri prefix of Tensorflow JavaScript binary files - // 'groupX-shardXofX.bin' Deprecated. + // TfJsBinaryGcsPrefix: Google Cloud Storage URI prefix of Tensorflow + // JavaScript binary files 'groupX-shardXofX.bin'. Deprecated. TfJsBinaryGcsPrefix string `json:"tfJsBinaryGcsPrefix,omitempty"` - // TfLiteMetadataGcsUri: GCS uri of Tensorflow Lite metadata + // TfLiteMetadataGcsUri: Google Cloud Storage URI of Tensorflow Lite metadata // 'tflite_metadata.json'. TfLiteMetadataGcsUri string `json:"tfLiteMetadataGcsUri,omitempty"` // ForceSendFields is a list of field names (e.g. "CheckpointArtifact") to @@ -3502,7 +3501,7 @@ type XPSImageModelServingSpecModelThroughputEstimation struct { // traffic, US-based traffic, or very large models should use this partition. // Capacity in this partition is significantly cheaper than partition-0. // "PARTITION_JELLYFISH" - To be used by customers with Jellyfish-accelerated - // ops. See go/servomatic-jellyfish for details. + // ops. // "PARTITION_CPU" - The partition used by regionalized servomatic cloud // regions. // "PARTITION_CUSTOM_STORAGE_CPU" - The partition used for loading models @@ -3873,8 +3872,7 @@ type XPSModelArtifactItem struct { // "CORE_ML" - Used for iOS mobile devices in (.mlmodel) format. See // https://developer.apple.com/documentation/coreml ArtifactFormat string `json:"artifactFormat,omitempty"` - // GcsUri: The Google Cloud Storage (GCS) uri that stores the model binary - // files. + // GcsUri: The Google Cloud Storage URI that stores the model binary files. GcsUri string `json:"gcsUri,omitempty"` // ForceSendFields is a list of field names (e.g. "ArtifactFormat") to // unconditionally include in API requests. By default, fields with empty or @@ -3894,7 +3892,6 @@ func (s XPSModelArtifactItem) MarshalJSON() ([]byte, error) { return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) } -// XPSPreprocessResponse: Next ID: 8 type XPSPreprocessResponse struct { // OutputExampleSet: Preprocessed examples, that are to be imported into AutoML // storage. This should point to RecordIO file(s) of PreprocessedExample @@ -4162,8 +4159,7 @@ func (s XPSResponseExplanationParameters) MarshalJSON() ([]byte, error) { } // XPSResponseExplanationSpec: Specification of Model explanation. -// Feature-based XAI in AutoML Vision ICN is deprecated, see b/288407203 for -// context. +// Feature-based XAI in AutoML Vision ICN is deprecated. type XPSResponseExplanationSpec struct { // ExplanationType: Explanation type. For AutoML Image Classification models, // possible values are: * `image-integrated-gradients` * `image-xrai` @@ -4702,7 +4698,6 @@ func (s *XPSTablesConfidenceMetricsEntry) UnmarshalJSON(data []byte) error { } // XPSTablesDatasetMetadata: Metadata for a dataset used for AutoML Tables. -// Next ID: 6 type XPSTablesDatasetMetadata struct { // MlUseColumnId: Id the column to split the table. MlUseColumnId int64 `json:"mlUseColumnId,omitempty"` @@ -5040,7 +5035,7 @@ func (s XPSTablesTrainingOperationMetadata) MarshalJSON() ([]byte, error) { return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) } -// XPSTextComponentModel: Component model. Next ID: 10 +// XPSTextComponentModel: Component model. type XPSTextComponentModel struct { // BatchPredictionModelGcsUri: The Cloud Storage resource path to hold batch // prediction model. @@ -5060,7 +5055,7 @@ type XPSTextComponentModel struct { // traffic, US-based traffic, or very large models should use this partition. // Capacity in this partition is significantly cheaper than partition-0. // "PARTITION_JELLYFISH" - To be used by customers with Jellyfish-accelerated - // ops. See go/servomatic-jellyfish for details. + // ops. // "PARTITION_CPU" - The partition used by regionalized servomatic cloud // regions. // "PARTITION_CUSTOM_STORAGE_CPU" - The partition used for loading models @@ -5090,8 +5085,7 @@ type XPSTextComponentModel struct { // "TEXT_MODEL_TYPE_COMPOSITE" - A composite model represents a set of // component models that have to be used together for prediction. A composite // model appears to be a single model to the model user. It may contain only - // one component model. Please refer to go/cnl-composite-models for more - // information. + // one component model. // "TEXT_MODEL_TYPE_ALL_MODELS" - Model type used to train default, MA, and // ATC models in a single batch worker pipeline. // "TEXT_MODEL_TYPE_BERT" - BERT pipeline needs a specific model type, since @@ -5430,7 +5424,6 @@ func (s *XPSTrackMetricsEntryConfidenceMetricsEntry) UnmarshalJSON(data []byte) return nil } -// XPSTrainResponse: Next ID: 18 type XPSTrainResponse struct { // DeployedModelSizeBytes: Estimated model size in bytes once deployed. DeployedModelSizeBytes int64 `json:"deployedModelSizeBytes,omitempty,string"` @@ -5847,8 +5840,9 @@ func (s XPSVideoClassificationTrainResponse) MarshalJSON() ([]byte, error) { // requesting format. type XPSVideoExportModelSpec struct { // ExportModelOutputConfig: Contains the model format and internal location of - // the model files to be exported/downloaded. Use the GCS bucket name which is - // provided via TrainRequest.gcs_bucket_name to store the model files. + // the model files to be exported/downloaded. Use the Google Cloud Storage + // bucket name which is provided via TrainRequest.gcs_bucket_name to store the + // model files. ExportModelOutputConfig []*XPSExportModelOutputConfig `json:"exportModelOutputConfig,omitempty"` // ForceSendFields is a list of field names (e.g. "ExportModelOutputConfig") to // unconditionally include in API requests. By default, fields with empty or diff --git a/language/v1beta2/language-api.json b/language/v1beta2/language-api.json index a4dcc870c24..c4b6b7971e4 100644 --- a/language/v1beta2/language-api.json +++ b/language/v1beta2/language-api.json @@ -246,7 +246,7 @@ } } }, - "revision": "20240929", + "revision": "20241103", "rootUrl": "https://language.googleapis.com/", "schemas": { "AnalyzeEntitiesRequest": { @@ -472,7 +472,7 @@ "type": "object" }, "AnnotateTextRequestFeatures": { - "description": "All available features for sentiment, syntax, and semantic analysis. Setting each one to true will enable that specific analysis for the input. Next ID: 12", + "description": "All available features for sentiment, syntax, and semantic analysis. Setting each one to true will enable that specific analysis for the input.", "id": "AnnotateTextRequestFeatures", "properties": { "classificationModelOptions": { @@ -1361,7 +1361,7 @@ }, "sentiment": { "$ref": "Sentiment", - "description": "For calls to AnalyzeEntitySentiment or if AnnotateTextRequest.Features.extract_entity_sentiment is set to true, this field will contain the aggregate sentiment expressed for this entity in the provided document." + "description": "For calls to AnalyzeEntitySentimentRequest or if AnnotateTextRequest.Features.extract_entity_sentiment is set to true, this field will contain the aggregate sentiment expressed for this entity in the provided document." }, "type": { "description": "The entity type.", @@ -1406,7 +1406,7 @@ "properties": { "sentiment": { "$ref": "Sentiment", - "description": "For calls to AnalyzeEntitySentiment or if AnnotateTextRequest.Features.extract_entity_sentiment is set to true, this field will contain the sentiment expressed for this mention of the entity in the provided document." + "description": "For calls to AnalyzeEntitySentimentRequest or if AnnotateTextRequest.Features.extract_entity_sentiment is set to true, this field will contain the sentiment expressed for this mention of the entity in the provided document." }, "text": { "$ref": "TextSpan", @@ -1808,7 +1808,7 @@ "type": "object" }, "InfraUsage": { - "description": "Infra Usage of billing metrics. Next ID: 6", + "description": "Infra Usage of billing metrics.", "id": "InfraUsage", "properties": { "cpuMetrics": { @@ -2540,7 +2540,7 @@ "properties": { "sentiment": { "$ref": "Sentiment", - "description": "For calls to AnalyzeSentiment or if AnnotateTextRequest.Features.extract_document_sentiment is set to true, this field will contain the sentiment for the sentence." + "description": "For calls to AnalyzeSentimentRequest or if AnnotateTextRequest.Features.extract_document_sentiment is set to true, this field will contain the sentiment for the sentence." }, "text": { "$ref": "TextSpan", @@ -2550,11 +2550,11 @@ "type": "object" }, "Sentiment": { - "description": "Represents the feeling associated with the entire text or entities in the text. Next ID: 6", + "description": "Represents the feeling associated with the entire text or entities in the text.", "id": "Sentiment", "properties": { "magnitude": { - "description": "A non-negative number in the [0, +inf) range, which represents the absolute magnitude of sentiment regardless of score (positive or negative).", + "description": "A non-negative number in the [0, +inf] range, which represents the absolute magnitude of sentiment regardless of score (positive or negative).", "format": "float", "type": "number" }, @@ -2907,7 +2907,6 @@ "type": "object" }, "XPSColumnSpecForecastingMetadata": { - "description": "=========================================================================== # The fields below are used exclusively for Forecasting.", "id": "XPSColumnSpecForecastingMetadata", "properties": { "columnType": { @@ -3400,11 +3399,11 @@ "type": "boolean" }, "outputGcrUri": { - "description": "The Google Contained Registry (GCR) path the exported files to be pushed to. This location is set if the exported format is DOCKDER.", + "description": "The Google Contained Registry path the exported files to be pushed to. This location is set if the exported format is DOCKDER.", "type": "string" }, "outputGcsUri": { - "description": "The Google Cloud Storage (GCS) directory where XPS will output the exported models and related files. Format: gs://bucket/directory", + "description": "The Google Cloud Storage directory where XPS will output the exported models and related files. Format: gs://bucket/directory", "type": "string" }, "tfJsFormat": { @@ -3420,7 +3419,7 @@ "type": "object" }, "XPSFileSpec": { - "description": "Spec of input and output files, on external file systems (CNS, GCS, etc).", + "description": "Spec of input and output files, on external file systems (for example, Colossus Namespace System or Google Cloud Storage).", "id": "XPSFileSpec", "properties": { "directoryPath": { @@ -3448,7 +3447,7 @@ "enumDescriptions": [ "", "", - "Internal format for parallel text data used by Google Translate. go/rkvtools", + "Internal format for parallel text data used by Google Translate.", "", "Only the lexicographically first file described by the file_spec contains the header line.", "" @@ -3577,7 +3576,7 @@ "id": "XPSImageExportModelSpec", "properties": { "exportModelOutputConfig": { - "description": "Contains the model format and internal location of the model files to be exported/downloaded. Use the GCS bucket name which is provided via TrainRequest.gcs_bucket_name to store the model files.", + "description": "Contains the model format and internal location of the model files to be exported/downloaded. Use the Google Cloud Storage bucket name which is provided via TrainRequest.gcs_bucket_name to store the model files.", "items": { "$ref": "XPSExportModelOutputConfig" }, @@ -3602,7 +3601,7 @@ "type": "array" }, "labelGcsUri": { - "description": "GCS uri of decoded labels file for model export 'dict.txt'.", + "description": "Google Cloud Storage URI of decoded labels file for model export 'dict.txt'.", "type": "string" }, "servingArtifact": { @@ -3610,11 +3609,11 @@ "description": "The default model binary file used for serving (e.g. online predict, batch predict) via public Cloud AI Platform API." }, "tfJsBinaryGcsPrefix": { - "description": "GCS uri prefix of Tensorflow JavaScript binary files 'groupX-shardXofX.bin' Deprecated.", + "description": "Google Cloud Storage URI prefix of Tensorflow JavaScript binary files 'groupX-shardXofX.bin'. Deprecated.", "type": "string" }, "tfLiteMetadataGcsUri": { - "description": "GCS uri of Tensorflow Lite metadata 'tflite_metadata.json'.", + "description": "Google Cloud Storage URI of Tensorflow Lite metadata 'tflite_metadata.json'.", "type": "string" } }, @@ -3706,7 +3705,7 @@ "", "The default partition.", "It has significantly lower replication than partition-0 and is located in the US only. It also has a larger model size limit and higher default RAM quota than partition-0. Customers with batch traffic, US-based traffic, or very large models should use this partition. Capacity in this partition is significantly cheaper than partition-0.", - "To be used by customers with Jellyfish-accelerated ops. See go/servomatic-jellyfish for details.", + "To be used by customers with Jellyfish-accelerated ops.", "The partition used by regionalized servomatic cloud regions.", "The partition used for loading models from custom storage." ], @@ -3966,14 +3965,13 @@ "type": "string" }, "gcsUri": { - "description": "The Google Cloud Storage (GCS) uri that stores the model binary files.", + "description": "The Google Cloud Storage URI that stores the model binary files.", "type": "string" } }, "type": "object" }, "XPSPreprocessResponse": { - "description": "Next ID: 8", "id": "XPSPreprocessResponse", "properties": { "outputExampleSet": { @@ -4147,7 +4145,7 @@ }, "XPSResponseExplanationSpec": { "deprecated": true, - "description": "Specification of Model explanation. Feature-based XAI in AutoML Vision ICN is deprecated, see b/288407203 for context.", + "description": "Specification of Model explanation. Feature-based XAI in AutoML Vision ICN is deprecated.", "id": "XPSResponseExplanationSpec", "properties": { "explanationType": { @@ -4603,7 +4601,7 @@ "type": "object" }, "XPSTablesDatasetMetadata": { - "description": "Metadata for a dataset used for AutoML Tables. Next ID: 6", + "description": "Metadata for a dataset used for AutoML Tables.", "id": "XPSTablesDatasetMetadata", "properties": { "mlUseColumnId": { @@ -4847,7 +4845,7 @@ "type": "object" }, "XPSTextComponentModel": { - "description": "Component model. Next ID: 10", + "description": "Component model.", "id": "XPSTextComponentModel", "properties": { "batchPredictionModelGcsUri": { @@ -4872,7 +4870,7 @@ "", "The default partition.", "It has significantly lower replication than partition-0 and is located in the US only. It also has a larger model size limit and higher default RAM quota than partition-0. Customers with batch traffic, US-based traffic, or very large models should use this partition. Capacity in this partition is significantly cheaper than partition-0.", - "To be used by customers with Jellyfish-accelerated ops. See go/servomatic-jellyfish for details.", + "To be used by customers with Jellyfish-accelerated ops.", "The partition used by regionalized servomatic cloud regions.", "The partition used for loading models from custom storage." ], @@ -4917,7 +4915,7 @@ "", "Model type for entity extraction.", "Model type for relationship extraction.", - "A composite model represents a set of component models that have to be used together for prediction. A composite model appears to be a single model to the model user. It may contain only one component model. Please refer to go/cnl-composite-models for more information.", + "A composite model represents a set of component models that have to be used together for prediction. A composite model appears to be a single model to the model user. It may contain only one component model.", "Model type used to train default, MA, and ATC models in a single batch worker pipeline.", "BERT pipeline needs a specific model type, since it uses a different TFX configuration compared with DEFAULT (despite sharing most of the code).", "Model type for EncPaLM." @@ -5152,7 +5150,6 @@ "type": "object" }, "XPSTrainResponse": { - "description": "Next ID: 18", "id": "XPSTrainResponse", "properties": { "deployedModelSizeBytes": { @@ -5429,7 +5426,7 @@ "id": "XPSVideoExportModelSpec", "properties": { "exportModelOutputConfig": { - "description": "Contains the model format and internal location of the model files to be exported/downloaded. Use the GCS bucket name which is provided via TrainRequest.gcs_bucket_name to store the model files.", + "description": "Contains the model format and internal location of the model files to be exported/downloaded. Use the Google Cloud Storage bucket name which is provided via TrainRequest.gcs_bucket_name to store the model files.", "items": { "$ref": "XPSExportModelOutputConfig" }, diff --git a/language/v1beta2/language-gen.go b/language/v1beta2/language-gen.go index ea2fdecfcbc..1481f99d5bc 100644 --- a/language/v1beta2/language-gen.go +++ b/language/v1beta2/language-gen.go @@ -490,7 +490,7 @@ func (s AnnotateTextRequest) MarshalJSON() ([]byte, error) { // AnnotateTextRequestFeatures: All available features for sentiment, syntax, // and semantic analysis. Setting each one to true will enable that specific -// analysis for the input. Next ID: 12 +// analysis for the input. type AnnotateTextRequestFeatures struct { // ClassificationModelOptions: Optional. The model options to use for // classification. Defaults to v1 options if not specified. Only used if @@ -1262,7 +1262,7 @@ type Entity struct { // importance or centrality of that entity to the entire document text. Scores // closer to 0 are less salient, while scores closer to 1.0 are highly salient. Salience float64 `json:"salience,omitempty"` - // Sentiment: For calls to AnalyzeEntitySentiment or if + // Sentiment: For calls to AnalyzeEntitySentimentRequest or if // AnnotateTextRequest.Features.extract_entity_sentiment is set to true, this // field will contain the aggregate sentiment expressed for this entity in the // provided document. @@ -1333,7 +1333,7 @@ func (s *Entity) UnmarshalJSON(data []byte) error { // EntityMention: Represents a mention for an entity in the text. Currently, // proper noun mentions are supported. type EntityMention struct { - // Sentiment: For calls to AnalyzeEntitySentiment or if + // Sentiment: For calls to AnalyzeEntitySentimentRequest or if // AnnotateTextRequest.Features.extract_entity_sentiment is set to true, this // field will contain the sentiment expressed for this mention of the entity in // the provided document. @@ -1571,7 +1571,7 @@ func (s GpuMetric) MarshalJSON() ([]byte, error) { return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) } -// InfraUsage: Infra Usage of billing metrics. Next ID: 6 +// InfraUsage: Infra Usage of billing metrics. type InfraUsage struct { // CpuMetrics: Aggregated core metrics since requested start_time. CpuMetrics []*CpuMetric `json:"cpuMetrics,omitempty"` @@ -2040,7 +2040,7 @@ func (s *RamMetric) UnmarshalJSON(data []byte) error { // Sentence: Represents a sentence in the input document. type Sentence struct { - // Sentiment: For calls to AnalyzeSentiment or if + // Sentiment: For calls to AnalyzeSentimentRequest or if // AnnotateTextRequest.Features.extract_document_sentiment is set to true, this // field will contain the sentiment for the sentence. Sentiment *Sentiment `json:"sentiment,omitempty"` @@ -2065,9 +2065,9 @@ func (s Sentence) MarshalJSON() ([]byte, error) { } // Sentiment: Represents the feeling associated with the entire text or -// entities in the text. Next ID: 6 +// entities in the text. type Sentiment struct { - // Magnitude: A non-negative number in the [0, +inf) range, which represents + // Magnitude: A non-negative number in the [0, +inf] range, which represents // the absolute magnitude of sentiment regardless of score (positive or // negative). Magnitude float64 `json:"magnitude,omitempty"` @@ -2602,9 +2602,6 @@ func (s XPSColumnSpecCorrelatedColumn) MarshalJSON() ([]byte, error) { return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) } -// XPSColumnSpecForecastingMetadata: -// =========================================================================== -// # The fields below are used exclusively for Forecasting. type XPSColumnSpecForecastingMetadata struct { // ColumnType: The type of the column for FORECASTING model training purposes. // @@ -3157,11 +3154,11 @@ type XPSExportModelOutputConfig struct { // ExportFirebaseAuxiliaryInfo: For any model and format: If true, will // additionally export FirebaseExportedModelInfo in a firebase.txt file. ExportFirebaseAuxiliaryInfo bool `json:"exportFirebaseAuxiliaryInfo,omitempty"` - // OutputGcrUri: The Google Contained Registry (GCR) path the exported files to - // be pushed to. This location is set if the exported format is DOCKDER. + // OutputGcrUri: The Google Contained Registry path the exported files to be + // pushed to. This location is set if the exported format is DOCKDER. OutputGcrUri string `json:"outputGcrUri,omitempty"` - // OutputGcsUri: The Google Cloud Storage (GCS) directory where XPS will output - // the exported models and related files. Format: gs://bucket/directory + // OutputGcsUri: The Google Cloud Storage directory where XPS will output the + // exported models and related files. Format: gs://bucket/directory OutputGcsUri string `json:"outputGcsUri,omitempty"` TfJsFormat *XPSTfJsFormat `json:"tfJsFormat,omitempty"` TfLiteFormat *XPSTfLiteFormat `json:"tfLiteFormat,omitempty"` @@ -3184,8 +3181,8 @@ func (s XPSExportModelOutputConfig) MarshalJSON() ([]byte, error) { return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) } -// XPSFileSpec: Spec of input and output files, on external file systems (CNS, -// GCS, etc). +// XPSFileSpec: Spec of input and output files, on external file systems (for +// example, Colossus Namespace System or Google Cloud Storage). type XPSFileSpec struct { // DirectoryPath: Deprecated. Use file_spec. DirectoryPath string `json:"directoryPath,omitempty"` @@ -3193,7 +3190,7 @@ type XPSFileSpec struct { // "FILE_FORMAT_UNKNOWN" // "FILE_FORMAT_SSTABLE" // "FILE_FORMAT_TRANSLATION_RKV" - Internal format for parallel text data - // used by Google Translate. go/rkvtools + // used by Google Translate. // "FILE_FORMAT_RECORDIO" // "FILE_FORMAT_RAW_CSV" - Only the lexicographically first file described by // the file_spec contains the header line. @@ -3382,8 +3379,9 @@ func (s XPSImageClassificationTrainResponse) MarshalJSON() ([]byte, error) { // requesting format. type XPSImageExportModelSpec struct { // ExportModelOutputConfig: Contains the model format and internal location of - // the model files to be exported/downloaded. Use the GCS bucket name which is - // provided via TrainRequest.gcs_bucket_name to store the model files. + // the model files to be exported/downloaded. Use the Google Cloud Storage + // bucket name which is provided via TrainRequest.gcs_bucket_name to store the + // model files. ExportModelOutputConfig []*XPSExportModelOutputConfig `json:"exportModelOutputConfig,omitempty"` // ForceSendFields is a list of field names (e.g. "ExportModelOutputConfig") to // unconditionally include in API requests. By default, fields with empty or @@ -3412,15 +3410,16 @@ type XPSImageModelArtifactSpec struct { // ExportArtifact: The model binary files in different formats for model // export. ExportArtifact []*XPSModelArtifactItem `json:"exportArtifact,omitempty"` - // LabelGcsUri: GCS uri of decoded labels file for model export 'dict.txt'. + // LabelGcsUri: Google Cloud Storage URI of decoded labels file for model + // export 'dict.txt'. LabelGcsUri string `json:"labelGcsUri,omitempty"` // ServingArtifact: The default model binary file used for serving (e.g. online // predict, batch predict) via public Cloud AI Platform API. ServingArtifact *XPSModelArtifactItem `json:"servingArtifact,omitempty"` - // TfJsBinaryGcsPrefix: GCS uri prefix of Tensorflow JavaScript binary files - // 'groupX-shardXofX.bin' Deprecated. + // TfJsBinaryGcsPrefix: Google Cloud Storage URI prefix of Tensorflow + // JavaScript binary files 'groupX-shardXofX.bin'. Deprecated. TfJsBinaryGcsPrefix string `json:"tfJsBinaryGcsPrefix,omitempty"` - // TfLiteMetadataGcsUri: GCS uri of Tensorflow Lite metadata + // TfLiteMetadataGcsUri: Google Cloud Storage URI of Tensorflow Lite metadata // 'tflite_metadata.json'. TfLiteMetadataGcsUri string `json:"tfLiteMetadataGcsUri,omitempty"` // ForceSendFields is a list of field names (e.g. "CheckpointArtifact") to @@ -3514,7 +3513,7 @@ type XPSImageModelServingSpecModelThroughputEstimation struct { // traffic, US-based traffic, or very large models should use this partition. // Capacity in this partition is significantly cheaper than partition-0. // "PARTITION_JELLYFISH" - To be used by customers with Jellyfish-accelerated - // ops. See go/servomatic-jellyfish for details. + // ops. // "PARTITION_CPU" - The partition used by regionalized servomatic cloud // regions. // "PARTITION_CUSTOM_STORAGE_CPU" - The partition used for loading models @@ -3885,8 +3884,7 @@ type XPSModelArtifactItem struct { // "CORE_ML" - Used for iOS mobile devices in (.mlmodel) format. See // https://developer.apple.com/documentation/coreml ArtifactFormat string `json:"artifactFormat,omitempty"` - // GcsUri: The Google Cloud Storage (GCS) uri that stores the model binary - // files. + // GcsUri: The Google Cloud Storage URI that stores the model binary files. GcsUri string `json:"gcsUri,omitempty"` // ForceSendFields is a list of field names (e.g. "ArtifactFormat") to // unconditionally include in API requests. By default, fields with empty or @@ -3906,7 +3904,6 @@ func (s XPSModelArtifactItem) MarshalJSON() ([]byte, error) { return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) } -// XPSPreprocessResponse: Next ID: 8 type XPSPreprocessResponse struct { // OutputExampleSet: Preprocessed examples, that are to be imported into AutoML // storage. This should point to RecordIO file(s) of PreprocessedExample @@ -4174,8 +4171,7 @@ func (s XPSResponseExplanationParameters) MarshalJSON() ([]byte, error) { } // XPSResponseExplanationSpec: Specification of Model explanation. -// Feature-based XAI in AutoML Vision ICN is deprecated, see b/288407203 for -// context. +// Feature-based XAI in AutoML Vision ICN is deprecated. type XPSResponseExplanationSpec struct { // ExplanationType: Explanation type. For AutoML Image Classification models, // possible values are: * `image-integrated-gradients` * `image-xrai` @@ -4714,7 +4710,6 @@ func (s *XPSTablesConfidenceMetricsEntry) UnmarshalJSON(data []byte) error { } // XPSTablesDatasetMetadata: Metadata for a dataset used for AutoML Tables. -// Next ID: 6 type XPSTablesDatasetMetadata struct { // MlUseColumnId: Id the column to split the table. MlUseColumnId int64 `json:"mlUseColumnId,omitempty"` @@ -5052,7 +5047,7 @@ func (s XPSTablesTrainingOperationMetadata) MarshalJSON() ([]byte, error) { return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) } -// XPSTextComponentModel: Component model. Next ID: 10 +// XPSTextComponentModel: Component model. type XPSTextComponentModel struct { // BatchPredictionModelGcsUri: The Cloud Storage resource path to hold batch // prediction model. @@ -5072,7 +5067,7 @@ type XPSTextComponentModel struct { // traffic, US-based traffic, or very large models should use this partition. // Capacity in this partition is significantly cheaper than partition-0. // "PARTITION_JELLYFISH" - To be used by customers with Jellyfish-accelerated - // ops. See go/servomatic-jellyfish for details. + // ops. // "PARTITION_CPU" - The partition used by regionalized servomatic cloud // regions. // "PARTITION_CUSTOM_STORAGE_CPU" - The partition used for loading models @@ -5102,8 +5097,7 @@ type XPSTextComponentModel struct { // "TEXT_MODEL_TYPE_COMPOSITE" - A composite model represents a set of // component models that have to be used together for prediction. A composite // model appears to be a single model to the model user. It may contain only - // one component model. Please refer to go/cnl-composite-models for more - // information. + // one component model. // "TEXT_MODEL_TYPE_ALL_MODELS" - Model type used to train default, MA, and // ATC models in a single batch worker pipeline. // "TEXT_MODEL_TYPE_BERT" - BERT pipeline needs a specific model type, since @@ -5442,7 +5436,6 @@ func (s *XPSTrackMetricsEntryConfidenceMetricsEntry) UnmarshalJSON(data []byte) return nil } -// XPSTrainResponse: Next ID: 18 type XPSTrainResponse struct { // DeployedModelSizeBytes: Estimated model size in bytes once deployed. DeployedModelSizeBytes int64 `json:"deployedModelSizeBytes,omitempty,string"` @@ -5859,8 +5852,9 @@ func (s XPSVideoClassificationTrainResponse) MarshalJSON() ([]byte, error) { // requesting format. type XPSVideoExportModelSpec struct { // ExportModelOutputConfig: Contains the model format and internal location of - // the model files to be exported/downloaded. Use the GCS bucket name which is - // provided via TrainRequest.gcs_bucket_name to store the model files. + // the model files to be exported/downloaded. Use the Google Cloud Storage + // bucket name which is provided via TrainRequest.gcs_bucket_name to store the + // model files. ExportModelOutputConfig []*XPSExportModelOutputConfig `json:"exportModelOutputConfig,omitempty"` // ForceSendFields is a list of field names (e.g. "ExportModelOutputConfig") to // unconditionally include in API requests. By default, fields with empty or diff --git a/language/v2/language-api.json b/language/v2/language-api.json index a7f5f6f331a..0bd68f3039c 100644 --- a/language/v2/language-api.json +++ b/language/v2/language-api.json @@ -208,7 +208,7 @@ } } }, - "revision": "20240929", + "revision": "20241103", "rootUrl": "https://language.googleapis.com/", "schemas": { "AnalyzeEntitiesRequest": { @@ -977,7 +977,7 @@ }, "sentiment": { "$ref": "Sentiment", - "description": "For calls to AnalyzeEntitySentiment or if AnnotateTextRequest.Features.extract_entity_sentiment is set to true, this field will contain the aggregate sentiment expressed for this entity in the provided document." + "description": "For calls to AnalyzeEntitySentimentRequest or if AnnotateTextRequest.Features.extract_entity_sentiment is set to true, this field will contain the aggregate sentiment expressed for this entity in the provided document." }, "type": { "description": "The entity type.", @@ -1027,7 +1027,7 @@ }, "sentiment": { "$ref": "Sentiment", - "description": "For calls to AnalyzeEntitySentiment or if AnnotateTextRequest.Features.extract_entity_sentiment is set to true, this field will contain the sentiment expressed for this mention of the entity in the provided document." + "description": "For calls to AnalyzeEntitySentimentRequest or if AnnotateTextRequest.Features.extract_entity_sentiment is set to true, this field will contain the sentiment expressed for this mention of the entity in the provided document." }, "text": { "$ref": "TextSpan", @@ -1429,7 +1429,7 @@ "type": "object" }, "InfraUsage": { - "description": "Infra Usage of billing metrics. Next ID: 6", + "description": "Infra Usage of billing metrics.", "id": "InfraUsage", "properties": { "cpuMetrics": { @@ -1916,7 +1916,7 @@ "properties": { "sentiment": { "$ref": "Sentiment", - "description": "For calls to AnalyzeSentiment or if AnnotateTextRequest.Features.extract_document_sentiment is set to true, this field will contain the sentiment for the sentence." + "description": "For calls to AnalyzeSentimentRequest or if AnnotateTextRequest.Features.extract_document_sentiment is set to true, this field will contain the sentiment for the sentence." }, "text": { "$ref": "TextSpan", @@ -1930,7 +1930,7 @@ "id": "Sentiment", "properties": { "magnitude": { - "description": "A non-negative number in the [0, +inf) range, which represents the absolute magnitude of sentiment regardless of score (positive or negative).", + "description": "A non-negative number in the [0, +inf] range, which represents the absolute magnitude of sentiment regardless of score (positive or negative).", "format": "float", "type": "number" }, @@ -2260,7 +2260,6 @@ "type": "object" }, "XPSColumnSpecForecastingMetadata": { - "description": "=========================================================================== # The fields below are used exclusively for Forecasting.", "id": "XPSColumnSpecForecastingMetadata", "properties": { "columnType": { @@ -2753,11 +2752,11 @@ "type": "boolean" }, "outputGcrUri": { - "description": "The Google Contained Registry (GCR) path the exported files to be pushed to. This location is set if the exported format is DOCKDER.", + "description": "The Google Contained Registry path the exported files to be pushed to. This location is set if the exported format is DOCKDER.", "type": "string" }, "outputGcsUri": { - "description": "The Google Cloud Storage (GCS) directory where XPS will output the exported models and related files. Format: gs://bucket/directory", + "description": "The Google Cloud Storage directory where XPS will output the exported models and related files. Format: gs://bucket/directory", "type": "string" }, "tfJsFormat": { @@ -2773,7 +2772,7 @@ "type": "object" }, "XPSFileSpec": { - "description": "Spec of input and output files, on external file systems (CNS, GCS, etc).", + "description": "Spec of input and output files, on external file systems (for example, Colossus Namespace System or Google Cloud Storage).", "id": "XPSFileSpec", "properties": { "directoryPath": { @@ -2801,7 +2800,7 @@ "enumDescriptions": [ "", "", - "Internal format for parallel text data used by Google Translate. go/rkvtools", + "Internal format for parallel text data used by Google Translate.", "", "Only the lexicographically first file described by the file_spec contains the header line.", "" @@ -2930,7 +2929,7 @@ "id": "XPSImageExportModelSpec", "properties": { "exportModelOutputConfig": { - "description": "Contains the model format and internal location of the model files to be exported/downloaded. Use the GCS bucket name which is provided via TrainRequest.gcs_bucket_name to store the model files.", + "description": "Contains the model format and internal location of the model files to be exported/downloaded. Use the Google Cloud Storage bucket name which is provided via TrainRequest.gcs_bucket_name to store the model files.", "items": { "$ref": "XPSExportModelOutputConfig" }, @@ -2955,7 +2954,7 @@ "type": "array" }, "labelGcsUri": { - "description": "GCS uri of decoded labels file for model export 'dict.txt'.", + "description": "Google Cloud Storage URI of decoded labels file for model export 'dict.txt'.", "type": "string" }, "servingArtifact": { @@ -2963,11 +2962,11 @@ "description": "The default model binary file used for serving (e.g. online predict, batch predict) via public Cloud AI Platform API." }, "tfJsBinaryGcsPrefix": { - "description": "GCS uri prefix of Tensorflow JavaScript binary files 'groupX-shardXofX.bin' Deprecated.", + "description": "Google Cloud Storage URI prefix of Tensorflow JavaScript binary files 'groupX-shardXofX.bin'. Deprecated.", "type": "string" }, "tfLiteMetadataGcsUri": { - "description": "GCS uri of Tensorflow Lite metadata 'tflite_metadata.json'.", + "description": "Google Cloud Storage URI of Tensorflow Lite metadata 'tflite_metadata.json'.", "type": "string" } }, @@ -3059,7 +3058,7 @@ "", "The default partition.", "It has significantly lower replication than partition-0 and is located in the US only. It also has a larger model size limit and higher default RAM quota than partition-0. Customers with batch traffic, US-based traffic, or very large models should use this partition. Capacity in this partition is significantly cheaper than partition-0.", - "To be used by customers with Jellyfish-accelerated ops. See go/servomatic-jellyfish for details.", + "To be used by customers with Jellyfish-accelerated ops.", "The partition used by regionalized servomatic cloud regions.", "The partition used for loading models from custom storage." ], @@ -3319,14 +3318,13 @@ "type": "string" }, "gcsUri": { - "description": "The Google Cloud Storage (GCS) uri that stores the model binary files.", + "description": "The Google Cloud Storage URI that stores the model binary files.", "type": "string" } }, "type": "object" }, "XPSPreprocessResponse": { - "description": "Next ID: 8", "id": "XPSPreprocessResponse", "properties": { "outputExampleSet": { @@ -3500,7 +3498,7 @@ }, "XPSResponseExplanationSpec": { "deprecated": true, - "description": "Specification of Model explanation. Feature-based XAI in AutoML Vision ICN is deprecated, see b/288407203 for context.", + "description": "Specification of Model explanation. Feature-based XAI in AutoML Vision ICN is deprecated.", "id": "XPSResponseExplanationSpec", "properties": { "explanationType": { @@ -3956,7 +3954,7 @@ "type": "object" }, "XPSTablesDatasetMetadata": { - "description": "Metadata for a dataset used for AutoML Tables. Next ID: 6", + "description": "Metadata for a dataset used for AutoML Tables.", "id": "XPSTablesDatasetMetadata", "properties": { "mlUseColumnId": { @@ -4200,7 +4198,7 @@ "type": "object" }, "XPSTextComponentModel": { - "description": "Component model. Next ID: 10", + "description": "Component model.", "id": "XPSTextComponentModel", "properties": { "batchPredictionModelGcsUri": { @@ -4225,7 +4223,7 @@ "", "The default partition.", "It has significantly lower replication than partition-0 and is located in the US only. It also has a larger model size limit and higher default RAM quota than partition-0. Customers with batch traffic, US-based traffic, or very large models should use this partition. Capacity in this partition is significantly cheaper than partition-0.", - "To be used by customers with Jellyfish-accelerated ops. See go/servomatic-jellyfish for details.", + "To be used by customers with Jellyfish-accelerated ops.", "The partition used by regionalized servomatic cloud regions.", "The partition used for loading models from custom storage." ], @@ -4270,7 +4268,7 @@ "", "Model type for entity extraction.", "Model type for relationship extraction.", - "A composite model represents a set of component models that have to be used together for prediction. A composite model appears to be a single model to the model user. It may contain only one component model. Please refer to go/cnl-composite-models for more information.", + "A composite model represents a set of component models that have to be used together for prediction. A composite model appears to be a single model to the model user. It may contain only one component model.", "Model type used to train default, MA, and ATC models in a single batch worker pipeline.", "BERT pipeline needs a specific model type, since it uses a different TFX configuration compared with DEFAULT (despite sharing most of the code).", "Model type for EncPaLM." @@ -4505,7 +4503,6 @@ "type": "object" }, "XPSTrainResponse": { - "description": "Next ID: 18", "id": "XPSTrainResponse", "properties": { "deployedModelSizeBytes": { @@ -4782,7 +4779,7 @@ "id": "XPSVideoExportModelSpec", "properties": { "exportModelOutputConfig": { - "description": "Contains the model format and internal location of the model files to be exported/downloaded. Use the GCS bucket name which is provided via TrainRequest.gcs_bucket_name to store the model files.", + "description": "Contains the model format and internal location of the model files to be exported/downloaded. Use the Google Cloud Storage bucket name which is provided via TrainRequest.gcs_bucket_name to store the model files.", "items": { "$ref": "XPSExportModelOutputConfig" }, diff --git a/language/v2/language-gen.go b/language/v2/language-gen.go index 949a9f6b686..81703fc2a0a 100644 --- a/language/v2/language-gen.go +++ b/language/v2/language-gen.go @@ -943,7 +943,7 @@ type Entity struct { Metadata map[string]string `json:"metadata,omitempty"` // Name: The representative name for the entity. Name string `json:"name,omitempty"` - // Sentiment: For calls to AnalyzeEntitySentiment or if + // Sentiment: For calls to AnalyzeEntitySentimentRequest or if // AnnotateTextRequest.Features.extract_entity_sentiment is set to true, this // field will contain the aggregate sentiment expressed for this entity in the // provided document. @@ -1004,7 +1004,7 @@ type EntityMention struct { // the probability of the entity mention being the entity type. The score is in // (0, 1] range. Probability float64 `json:"probability,omitempty"` - // Sentiment: For calls to AnalyzeEntitySentiment or if + // Sentiment: For calls to AnalyzeEntitySentimentRequest or if // AnnotateTextRequest.Features.extract_entity_sentiment is set to true, this // field will contain the sentiment expressed for this mention of the entity in // the provided document. @@ -1256,7 +1256,7 @@ func (s GpuMetric) MarshalJSON() ([]byte, error) { return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) } -// InfraUsage: Infra Usage of billing metrics. Next ID: 6 +// InfraUsage: Infra Usage of billing metrics. type InfraUsage struct { // CpuMetrics: Aggregated core metrics since requested start_time. CpuMetrics []*CpuMetric `json:"cpuMetrics,omitempty"` @@ -1584,7 +1584,7 @@ func (s *RamMetric) UnmarshalJSON(data []byte) error { // Sentence: Represents a sentence in the input document. type Sentence struct { - // Sentiment: For calls to AnalyzeSentiment or if + // Sentiment: For calls to AnalyzeSentimentRequest or if // AnnotateTextRequest.Features.extract_document_sentiment is set to true, this // field will contain the sentiment for the sentence. Sentiment *Sentiment `json:"sentiment,omitempty"` @@ -1611,7 +1611,7 @@ func (s Sentence) MarshalJSON() ([]byte, error) { // Sentiment: Represents the feeling associated with the entire text or // entities in the text. type Sentiment struct { - // Magnitude: A non-negative number in the [0, +inf) range, which represents + // Magnitude: A non-negative number in the [0, +inf] range, which represents // the absolute magnitude of sentiment regardless of score (positive or // negative). Magnitude float64 `json:"magnitude,omitempty"` @@ -2117,9 +2117,6 @@ func (s XPSColumnSpecCorrelatedColumn) MarshalJSON() ([]byte, error) { return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) } -// XPSColumnSpecForecastingMetadata: -// =========================================================================== -// # The fields below are used exclusively for Forecasting. type XPSColumnSpecForecastingMetadata struct { // ColumnType: The type of the column for FORECASTING model training purposes. // @@ -2672,11 +2669,11 @@ type XPSExportModelOutputConfig struct { // ExportFirebaseAuxiliaryInfo: For any model and format: If true, will // additionally export FirebaseExportedModelInfo in a firebase.txt file. ExportFirebaseAuxiliaryInfo bool `json:"exportFirebaseAuxiliaryInfo,omitempty"` - // OutputGcrUri: The Google Contained Registry (GCR) path the exported files to - // be pushed to. This location is set if the exported format is DOCKDER. + // OutputGcrUri: The Google Contained Registry path the exported files to be + // pushed to. This location is set if the exported format is DOCKDER. OutputGcrUri string `json:"outputGcrUri,omitempty"` - // OutputGcsUri: The Google Cloud Storage (GCS) directory where XPS will output - // the exported models and related files. Format: gs://bucket/directory + // OutputGcsUri: The Google Cloud Storage directory where XPS will output the + // exported models and related files. Format: gs://bucket/directory OutputGcsUri string `json:"outputGcsUri,omitempty"` TfJsFormat *XPSTfJsFormat `json:"tfJsFormat,omitempty"` TfLiteFormat *XPSTfLiteFormat `json:"tfLiteFormat,omitempty"` @@ -2699,8 +2696,8 @@ func (s XPSExportModelOutputConfig) MarshalJSON() ([]byte, error) { return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) } -// XPSFileSpec: Spec of input and output files, on external file systems (CNS, -// GCS, etc). +// XPSFileSpec: Spec of input and output files, on external file systems (for +// example, Colossus Namespace System or Google Cloud Storage). type XPSFileSpec struct { // DirectoryPath: Deprecated. Use file_spec. DirectoryPath string `json:"directoryPath,omitempty"` @@ -2708,7 +2705,7 @@ type XPSFileSpec struct { // "FILE_FORMAT_UNKNOWN" // "FILE_FORMAT_SSTABLE" // "FILE_FORMAT_TRANSLATION_RKV" - Internal format for parallel text data - // used by Google Translate. go/rkvtools + // used by Google Translate. // "FILE_FORMAT_RECORDIO" // "FILE_FORMAT_RAW_CSV" - Only the lexicographically first file described by // the file_spec contains the header line. @@ -2897,8 +2894,9 @@ func (s XPSImageClassificationTrainResponse) MarshalJSON() ([]byte, error) { // requesting format. type XPSImageExportModelSpec struct { // ExportModelOutputConfig: Contains the model format and internal location of - // the model files to be exported/downloaded. Use the GCS bucket name which is - // provided via TrainRequest.gcs_bucket_name to store the model files. + // the model files to be exported/downloaded. Use the Google Cloud Storage + // bucket name which is provided via TrainRequest.gcs_bucket_name to store the + // model files. ExportModelOutputConfig []*XPSExportModelOutputConfig `json:"exportModelOutputConfig,omitempty"` // ForceSendFields is a list of field names (e.g. "ExportModelOutputConfig") to // unconditionally include in API requests. By default, fields with empty or @@ -2927,15 +2925,16 @@ type XPSImageModelArtifactSpec struct { // ExportArtifact: The model binary files in different formats for model // export. ExportArtifact []*XPSModelArtifactItem `json:"exportArtifact,omitempty"` - // LabelGcsUri: GCS uri of decoded labels file for model export 'dict.txt'. + // LabelGcsUri: Google Cloud Storage URI of decoded labels file for model + // export 'dict.txt'. LabelGcsUri string `json:"labelGcsUri,omitempty"` // ServingArtifact: The default model binary file used for serving (e.g. online // predict, batch predict) via public Cloud AI Platform API. ServingArtifact *XPSModelArtifactItem `json:"servingArtifact,omitempty"` - // TfJsBinaryGcsPrefix: GCS uri prefix of Tensorflow JavaScript binary files - // 'groupX-shardXofX.bin' Deprecated. + // TfJsBinaryGcsPrefix: Google Cloud Storage URI prefix of Tensorflow + // JavaScript binary files 'groupX-shardXofX.bin'. Deprecated. TfJsBinaryGcsPrefix string `json:"tfJsBinaryGcsPrefix,omitempty"` - // TfLiteMetadataGcsUri: GCS uri of Tensorflow Lite metadata + // TfLiteMetadataGcsUri: Google Cloud Storage URI of Tensorflow Lite metadata // 'tflite_metadata.json'. TfLiteMetadataGcsUri string `json:"tfLiteMetadataGcsUri,omitempty"` // ForceSendFields is a list of field names (e.g. "CheckpointArtifact") to @@ -3029,7 +3028,7 @@ type XPSImageModelServingSpecModelThroughputEstimation struct { // traffic, US-based traffic, or very large models should use this partition. // Capacity in this partition is significantly cheaper than partition-0. // "PARTITION_JELLYFISH" - To be used by customers with Jellyfish-accelerated - // ops. See go/servomatic-jellyfish for details. + // ops. // "PARTITION_CPU" - The partition used by regionalized servomatic cloud // regions. // "PARTITION_CUSTOM_STORAGE_CPU" - The partition used for loading models @@ -3400,8 +3399,7 @@ type XPSModelArtifactItem struct { // "CORE_ML" - Used for iOS mobile devices in (.mlmodel) format. See // https://developer.apple.com/documentation/coreml ArtifactFormat string `json:"artifactFormat,omitempty"` - // GcsUri: The Google Cloud Storage (GCS) uri that stores the model binary - // files. + // GcsUri: The Google Cloud Storage URI that stores the model binary files. GcsUri string `json:"gcsUri,omitempty"` // ForceSendFields is a list of field names (e.g. "ArtifactFormat") to // unconditionally include in API requests. By default, fields with empty or @@ -3421,7 +3419,6 @@ func (s XPSModelArtifactItem) MarshalJSON() ([]byte, error) { return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) } -// XPSPreprocessResponse: Next ID: 8 type XPSPreprocessResponse struct { // OutputExampleSet: Preprocessed examples, that are to be imported into AutoML // storage. This should point to RecordIO file(s) of PreprocessedExample @@ -3689,8 +3686,7 @@ func (s XPSResponseExplanationParameters) MarshalJSON() ([]byte, error) { } // XPSResponseExplanationSpec: Specification of Model explanation. -// Feature-based XAI in AutoML Vision ICN is deprecated, see b/288407203 for -// context. +// Feature-based XAI in AutoML Vision ICN is deprecated. type XPSResponseExplanationSpec struct { // ExplanationType: Explanation type. For AutoML Image Classification models, // possible values are: * `image-integrated-gradients` * `image-xrai` @@ -4229,7 +4225,6 @@ func (s *XPSTablesConfidenceMetricsEntry) UnmarshalJSON(data []byte) error { } // XPSTablesDatasetMetadata: Metadata for a dataset used for AutoML Tables. -// Next ID: 6 type XPSTablesDatasetMetadata struct { // MlUseColumnId: Id the column to split the table. MlUseColumnId int64 `json:"mlUseColumnId,omitempty"` @@ -4567,7 +4562,7 @@ func (s XPSTablesTrainingOperationMetadata) MarshalJSON() ([]byte, error) { return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) } -// XPSTextComponentModel: Component model. Next ID: 10 +// XPSTextComponentModel: Component model. type XPSTextComponentModel struct { // BatchPredictionModelGcsUri: The Cloud Storage resource path to hold batch // prediction model. @@ -4587,7 +4582,7 @@ type XPSTextComponentModel struct { // traffic, US-based traffic, or very large models should use this partition. // Capacity in this partition is significantly cheaper than partition-0. // "PARTITION_JELLYFISH" - To be used by customers with Jellyfish-accelerated - // ops. See go/servomatic-jellyfish for details. + // ops. // "PARTITION_CPU" - The partition used by regionalized servomatic cloud // regions. // "PARTITION_CUSTOM_STORAGE_CPU" - The partition used for loading models @@ -4617,8 +4612,7 @@ type XPSTextComponentModel struct { // "TEXT_MODEL_TYPE_COMPOSITE" - A composite model represents a set of // component models that have to be used together for prediction. A composite // model appears to be a single model to the model user. It may contain only - // one component model. Please refer to go/cnl-composite-models for more - // information. + // one component model. // "TEXT_MODEL_TYPE_ALL_MODELS" - Model type used to train default, MA, and // ATC models in a single batch worker pipeline. // "TEXT_MODEL_TYPE_BERT" - BERT pipeline needs a specific model type, since @@ -4957,7 +4951,6 @@ func (s *XPSTrackMetricsEntryConfidenceMetricsEntry) UnmarshalJSON(data []byte) return nil } -// XPSTrainResponse: Next ID: 18 type XPSTrainResponse struct { // DeployedModelSizeBytes: Estimated model size in bytes once deployed. DeployedModelSizeBytes int64 `json:"deployedModelSizeBytes,omitempty,string"` @@ -5374,8 +5367,9 @@ func (s XPSVideoClassificationTrainResponse) MarshalJSON() ([]byte, error) { // requesting format. type XPSVideoExportModelSpec struct { // ExportModelOutputConfig: Contains the model format and internal location of - // the model files to be exported/downloaded. Use the GCS bucket name which is - // provided via TrainRequest.gcs_bucket_name to store the model files. + // the model files to be exported/downloaded. Use the Google Cloud Storage + // bucket name which is provided via TrainRequest.gcs_bucket_name to store the + // model files. ExportModelOutputConfig []*XPSExportModelOutputConfig `json:"exportModelOutputConfig,omitempty"` // ForceSendFields is a list of field names (e.g. "ExportModelOutputConfig") to // unconditionally include in API requests. By default, fields with empty or diff --git a/merchantapi/accounts_v1beta/merchantapi-api.json b/merchantapi/accounts_v1beta/merchantapi-api.json index c2295a12ad4..a7dccff6329 100644 --- a/merchantapi/accounts_v1beta/merchantapi-api.json +++ b/merchantapi/accounts_v1beta/merchantapi-api.json @@ -705,6 +705,299 @@ } } }, + "omnichannelSettings": { + "methods": { + "create": { + "description": "Create the omnichannel settings for a given merchant.", + "flatPath": "accounts/v1beta/accounts/{accountsId}/omnichannelSettings", + "httpMethod": "POST", + "id": "merchantapi.accounts.omnichannelSettings.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The parent resource where this omnichannel setting will be created. Format: `accounts/{account}`", + "location": "path", + "pattern": "^accounts/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "accounts/v1beta/{+parent}/omnichannelSettings", + "request": { + "$ref": "OmnichannelSetting" + }, + "response": { + "$ref": "OmnichannelSetting" + }, + "scopes": [ + "https://www.googleapis.com/auth/content" + ] + }, + "get": { + "description": "Get the omnichannel settings for a given merchant.", + "flatPath": "accounts/v1beta/accounts/{accountsId}/omnichannelSettings/{omnichannelSettingsId}", + "httpMethod": "GET", + "id": "merchantapi.accounts.omnichannelSettings.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the omnichannel setting to retrieve. Format: `accounts/{account}/omnichannelSettings/{omnichannel_setting}`", + "location": "path", + "pattern": "^accounts/[^/]+/omnichannelSettings/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "accounts/v1beta/{+name}", + "response": { + "$ref": "OmnichannelSetting" + }, + "scopes": [ + "https://www.googleapis.com/auth/content" + ] + }, + "list": { + "description": "List all the omnichannel settings for a given merchant.", + "flatPath": "accounts/v1beta/accounts/{accountsId}/omnichannelSettings", + "httpMethod": "GET", + "id": "merchantapi.accounts.omnichannelSettings.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "pageSize": { + "description": "Optional. The maximum number of omnichannel settings to return. The service may return fewer than this value. If unspecified, at most 50 omnichannel settings will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. A page token, received from a previous `ListOmnichannelSettings` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListOmnichannelSettings` must match the call that provided the page token.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The parent, which owns this collection of omnichannel settings. Format: `accounts/{account}`", + "location": "path", + "pattern": "^accounts/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "accounts/v1beta/{+parent}/omnichannelSettings", + "response": { + "$ref": "ListOmnichannelSettingsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/content" + ] + }, + "patch": { + "description": "Update the omnichannel setting for a given merchant in a given country.", + "flatPath": "accounts/v1beta/accounts/{accountsId}/omnichannelSettings/{omnichannelSettingsId}", + "httpMethod": "PATCH", + "id": "merchantapi.accounts.omnichannelSettings.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Identifier. The resource name of the omnichannel setting. Format: `accounts/{account}/omnichannelSettings/{omnichannel_setting}`", + "location": "path", + "pattern": "^accounts/[^/]+/omnichannelSettings/[^/]+$", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "Optional. The list of fields to be updated.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "accounts/v1beta/{+name}", + "request": { + "$ref": "OmnichannelSetting" + }, + "response": { + "$ref": "OmnichannelSetting" + }, + "scopes": [ + "https://www.googleapis.com/auth/content" + ] + }, + "requestInventoryVerification": { + "description": "Requests inventory verification for a given merchant in a given country.", + "flatPath": "accounts/v1beta/accounts/{accountsId}/omnichannelSettings/{omnichannelSettingsId}:requestInventoryVerification", + "httpMethod": "POST", + "id": "merchantapi.accounts.omnichannelSettings.requestInventoryVerification", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the omnichannel setting to request inventory verification. Format: `accounts/{account}/omnichannelSettings/{omnichannel_setting}`", + "location": "path", + "pattern": "^accounts/[^/]+/omnichannelSettings/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "accounts/v1beta/{+name}:requestInventoryVerification", + "request": { + "$ref": "RequestInventoryVerificationRequest" + }, + "response": { + "$ref": "RequestInventoryVerificationResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/content" + ] + } + }, + "resources": { + "gbpAccounts": { + "methods": { + "linkGbpAccount": { + "description": "Link the specified merchant to a GBP account for all countries.", + "flatPath": "accounts/v1beta/accounts/{accountsId}/omnichannelSettings/{omnichannelSettingsId}/gbpAccounts:linkGbpAccount", + "httpMethod": "POST", + "id": "merchantapi.accounts.omnichannelSettings.gbpAccounts.linkGbpAccount", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The name of the parent resource under which the GBP accounts are listed. Format: `accounts/{account}/omnichannelSettings/{omnichannel_setting}`.", + "location": "path", + "pattern": "^accounts/[^/]+/omnichannelSettings/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "accounts/v1beta/{+parent}/gbpAccounts:linkGbpAccount", + "request": { + "$ref": "LinkGbpAccountRequest" + }, + "response": { + "$ref": "LinkGbpAccountResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/content" + ] + }, + "list": { + "description": "List the GBP accounts for a given merchant.", + "flatPath": "accounts/v1beta/accounts/{accountsId}/omnichannelSettings/{omnichannelSettingsId}/gbpAccounts", + "httpMethod": "GET", + "id": "merchantapi.accounts.omnichannelSettings.gbpAccounts.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "pageSize": { + "description": "Optional. The maximum number of `GbpAccount` resources to return. The service returns fewer than this value if the number of gbp accounts is less that than the `pageSize`. The default value is 50. The maximum value is 1000; If a value higher than the maximum is specified, then the `pageSize` will default to the maximum.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. A page token, received from a previous `ListGbpAccounts` call. Provide the page token to retrieve the subsequent page. When paginating, all other parameters provided to `ListGbpAccounts` must match the call that provided the page token.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The name of the parent resource under which the GBP accounts are listed. Format: `accounts/{account}/omnichannelSettings/{omnichannel_setting}`.", + "location": "path", + "pattern": "^accounts/[^/]+/omnichannelSettings/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "accounts/v1beta/{+parent}/gbpAccounts", + "response": { + "$ref": "ListGbpAccountsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/content" + ] + } + } + }, + "lfpProviders": { + "methods": { + "linkLfpProvider": { + "description": "Link the specified merchant to a LFP provider for the specified country.", + "flatPath": "accounts/v1beta/accounts/{accountsId}/omnichannelSettings/{omnichannelSettingsId}/lfpProviders:linkLfpProvider", + "httpMethod": "POST", + "id": "merchantapi.accounts.omnichannelSettings.lfpProviders.linkLfpProvider", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The name of the parent resource under which the LFP provider is linked. Format: `accounts/{account}/omnichannelSettings/{omnichannel_setting}`.", + "location": "path", + "pattern": "^accounts/[^/]+/omnichannelSettings/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "accounts/v1beta/{+parent}/lfpProviders:linkLfpProvider", + "request": { + "$ref": "LinkLfpProviderRequest" + }, + "response": { + "$ref": "LinkLfpProviderResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/content" + ] + }, + "list": { + "description": "List the LFP provider settings for a given merchant in a given country.", + "flatPath": "accounts/v1beta/accounts/{accountsId}/omnichannelSettings/{omnichannelSettingsId}/lfpProviders", + "httpMethod": "GET", + "id": "merchantapi.accounts.omnichannelSettings.lfpProviders.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "pageSize": { + "description": "Optional. The maximum number of `LfpProvider` resources to return. The service returns fewer than this value if the number of lfp providers is less that than the `pageSize`. The default value is 50. The maximum value is 1000; If a value higher than the maximum is specified, then the `pageSize` will default to the maximum.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. A page token, received from a previous `ListLfpProviders` call. Provide the page token to retrieve the subsequent page. When paginating, all other parameters provided to `ListLfpProviders` must match the call that provided the page token.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The name of the parent resource under which the LFP providers are listed. Format: `accounts/{account}/omnichannelSettings/{omnichannel_setting}`.", + "location": "path", + "pattern": "^accounts/[^/]+/omnichannelSettings/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "accounts/v1beta/{+parent}/lfpProviders", + "response": { + "$ref": "ListLfpProvidersResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/content" + ] + } + } + } + } + }, "onlineReturnPolicies": { "methods": { "get": { @@ -1417,9 +1710,37 @@ } } }, - "revision": "20241029", + "revision": "20241101", "rootUrl": "https://merchantapi.googleapis.com/", "schemas": { + "About": { + "description": "Collection of information related to the about page ([impressum](https://support.google.com/merchants/answer/14675634?hl=en\u0026ref_topic=15145634\u0026sjid=6892280366904591178-NC)).", + "id": "About", + "properties": { + "state": { + "description": "Output only. The state of the URI.", + "enum": [ + "STATE_UNSPECIFIED", + "ACTIVE", + "FAILED", + "RUNNING" + ], + "enumDescriptions": [ + "Default value. This value is unused.", + "The review process is active.", + "The review process failed.", + "The review process is running." + ], + "readOnly": true, + "type": "string" + }, + "uri": { + "description": "Required. The about page URI.", + "type": "string" + } + }, + "type": "object" + }, "Accepted": { "description": "Describes the accepted terms of service.", "id": "Accepted", @@ -1671,7 +1992,7 @@ "type": "object" }, "BusinessInfo": { - "description": "The `BusinessInfo` message contains essential information about a merchant's business. This message captures key business details such as physical address, customer service contacts, and region-specific identifiers.", + "description": "Collection of information related to a business.", "id": "BusinessInfo", "properties": { "address": { @@ -2002,6 +2323,48 @@ "properties": {}, "type": "object" }, + "GbpAccount": { + "description": "Collection of information related to a Google Business Profile (GBP) account.", + "id": "GbpAccount", + "properties": { + "email": { + "description": "The email which identifies the Business Profile.", + "type": "string" + }, + "gbpAccountId": { + "description": "The id of the GBP account.", + "type": "string" + }, + "gbpAccountName": { + "description": "The name of the Business Profile. For personal accounts: Email id of the owner. For Business accounts: Name of the Business Account.", + "type": "string" + }, + "listingCount": { + "description": "Number of listings under this account.", + "format": "int64", + "type": "string" + }, + "name": { + "description": "Identifier. The resource name of the GBP account. Format: `accounts/{account}/omnichannelSettings/{omnichannel_setting}/gbpAccount/{gbp_account}`", + "type": "string" + }, + "type": { + "description": "The type of the Business Profile.", + "enum": [ + "TYPE_UNSPECIFIED", + "USER", + "BUSINESS_ACCOUNT" + ], + "enumDescriptions": [ + "Default value. This value is unused.", + "The GBP account is a user account.", + "The GBP account is a business account." + ], + "type": "string" + } + }, + "type": "object" + }, "GeoTargetArea": { "description": "A list of geotargets that defines the region area.", "id": "GeoTargetArea", @@ -2060,7 +2423,7 @@ "type": "object" }, "Homepage": { - "description": "The `Homepage` message represents a merchant's store homepage within the system. A merchant's homepage is the primary domain where customers interact with their store. The homepage can be claimed and verified as a proof of ownership and allows the merchant to unlock features that require a verified website. For more information, see [Understanding online store URL verification](//support.google.com/merchants/answer/176793).", + "description": "A store's homepage.", "id": "Homepage", "properties": { "claimed": { @@ -2157,7 +2520,8 @@ "CLOUD_RETAIL", "LOCAL_CLOUD_RETAIL", "PRODUCT_REVIEWS", - "MERCHANT_REVIEWS" + "MERCHANT_REVIEWS", + "YOUTUBE_CHECKOUT" ], "enumDeprecated": [ false, @@ -2176,6 +2540,7 @@ false, false, false, + false, false ], "enumDescriptions": [ @@ -2195,13 +2560,152 @@ "[Cloud retail](https://cloud.google.com/solutions/retail).", "[Local cloud retail](https://cloud.google.com/solutions/retail).", "[Product Reviews](https://support.google.com/merchants/answer/14620732).", - "[Merchant Reviews](https://developers.google.com/merchant-review-feeds)." + "[Merchant Reviews](https://developers.google.com/merchant-review-feeds).", + "[YouTube Checkout](" + ], + "type": "string" + } + }, + "type": "object" + }, + "InventoryVerification": { + "description": "Collection of information related to [inventory verification](https://support.google.com/merchants/answer/14684499?hl=en\u0026ref_topic=15145634\u0026sjid=6892280366904591178-NC).", + "id": "InventoryVerification", + "properties": { + "contact": { + "description": "Required. The name of the contact for the inventory verification process.", + "type": "string" + }, + "contactEmail": { + "description": "Required. The email address of the contact for the inventory verification process.", + "type": "string" + }, + "contactState": { + "description": "Output only. The state of the contact verification.", + "enum": [ + "STATE_UNSPECIFIED", + "ACTIVE", + "FAILED", + "RUNNING" + ], + "enumDescriptions": [ + "Default value. This value is unused.", + "The review process is active.", + "The review process failed.", + "The review process is running." + ], + "readOnly": true, + "type": "string" + }, + "state": { + "description": "Output only. The state of the inventory verification process.", + "enum": [ + "STATE_UNSPECIFIED", + "ACTION_REQUIRED", + "RUNNING", + "SUCCEEDED", + "SUSPENDED" + ], + "enumDescriptions": [ + "Default value. This value is unused.", + "When merchant fails the inventory verification process, but still have remaining attempts.", + "The inventory verification process is running.", + "The inventory verification process succeeded.", + "When merchant fails the inventory verification process and all attempts are exhausted." ], + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "LfpLink": { + "description": "Collection of information related to the LFP link.", + "id": "LfpLink", + "properties": { + "externalAccountId": { + "description": "Required. The account ID by which this merchant is known to the LFP provider.", + "type": "string" + }, + "providerId": { + "description": "Required. The ID of the LFP provider.", + "type": "string" + } + }, + "type": "object" + }, + "LfpProvider": { + "description": "Collection of information related to a Local Feed Partnership (LFP) provider.", + "id": "LfpProvider", + "properties": { + "displayName": { + "description": "The display name of the LFP provider.", + "type": "string" + }, + "lfpProviderId": { + "description": "The ID of the LFP provider.", + "type": "string" + }, + "name": { + "description": "Identifier. The resource name of the LFP provider. Format: `accounts/{account}/omnichannelSettings/{omnichannel_setting}/lfpProviders/{lfp_provider}`", + "type": "string" + }, + "regionCode": { + "description": "Output only. Region code defined by [CLDR](https://cldr.unicode.org/).", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "LinkGbpAccountRequest": { + "description": "Request message for the LinkGbpAccount method.", + "id": "LinkGbpAccountRequest", + "properties": { + "gbpEmail": { + "description": "Required. The email address of the Business Profile account.", + "type": "string" + } + }, + "type": "object" + }, + "LinkGbpAccountResponse": { + "description": "Response message for the LinkGbpAccount method.", + "id": "LinkGbpAccountResponse", + "properties": { + "response": { + "$ref": "Empty", + "description": "Empty response." + } + }, + "type": "object" + }, + "LinkLfpProviderRequest": { + "description": "Request message for the LinkLfpProvider method.", + "id": "LinkLfpProviderRequest", + "properties": { + "externalAccountId": { + "description": "Required. The external account ID by which this merchant is known to the LFP provider.", + "type": "string" + }, + "lfpProviderId": { + "description": "Required. The id of the LFP provider to link.", "type": "string" } }, "type": "object" }, + "LinkLfpProviderResponse": { + "description": "Response message for the LinkLfpProvider method.", + "id": "LinkLfpProviderResponse", + "properties": { + "response": { + "$ref": "Empty", + "description": "Empty response." + } + }, + "type": "object" + }, "ListAccountIssuesResponse": { "description": "Response message for the `ListAccountIssues` method.", "id": "ListAccountIssuesResponse", @@ -2238,6 +2742,60 @@ }, "type": "object" }, + "ListGbpAccountsResponse": { + "description": "Response message for the ListGbpAccounts method.", + "id": "ListGbpAccountsResponse", + "properties": { + "gbpAccounts": { + "description": "The GBP accounts from the specified merchant in the specified country.", + "items": { + "$ref": "GbpAccount" + }, + "type": "array" + }, + "nextPageToken": { + "description": "A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.", + "type": "string" + } + }, + "type": "object" + }, + "ListLfpProvidersResponse": { + "description": "Response message for the ListLfpProviders method.", + "id": "ListLfpProvidersResponse", + "properties": { + "lfpProviders": { + "description": "The LFP providers from the specified merchant in the specified country.", + "items": { + "$ref": "LfpProvider" + }, + "type": "array" + }, + "nextPageToken": { + "description": "A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.", + "type": "string" + } + }, + "type": "object" + }, + "ListOmnichannelSettingsResponse": { + "description": "Response message for the ListOmnichannelSettings method.", + "id": "ListOmnichannelSettingsResponse", + "properties": { + "nextPageToken": { + "description": "A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.", + "type": "string" + }, + "omnichannelSettings": { + "description": "The omnichannel settings from the specified merchant.", + "items": { + "$ref": "OmnichannelSetting" + }, + "type": "array" + } + }, + "type": "object" + }, "ListOnlineReturnPoliciesResponse": { "description": "Response message for the `ListOnlineReturnPolicies` method.", "id": "ListOnlineReturnPoliciesResponse", @@ -2388,6 +2946,46 @@ }, "type": "object" }, + "LsfType": { + "description": "Collection of information related to the Local Store Front (LSF) type.", + "id": "LsfType", + "properties": { + "lsfType": { + "description": "Required. The Local Store Front (LSF) type.", + "enum": [ + "TYPE_UNSPECIFIED", + "GHLSF", + "MHLSF_BASIC", + "MHLSF_FULL" + ], + "enumDescriptions": [ + "Default value. This value is unused.", + "Google-Hosted Local Store Front.", + "Merchant-Hosted Local Store Front Basic.", + "Merchant-Hosted Local Store Front Full." + ], + "type": "string" + }, + "state": { + "description": "Output only. The state of the LSF.", + "enum": [ + "STATE_UNSPECIFIED", + "ACTIVE", + "FAILED", + "RUNNING" + ], + "enumDescriptions": [ + "Default value. This value is unused.", + "The review process is active.", + "The review process failed.", + "The review process is running." + ], + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, "MinimumOrderValueTable": { "description": "Table of per store minimum order values for the pickup fulfillment type.", "id": "MinimumOrderValueTable", @@ -2402,6 +3000,94 @@ }, "type": "object" }, + "OmnichannelSetting": { + "description": "Collection of information related to the omnichannel settings of a merchant.", + "id": "OmnichannelSetting", + "properties": { + "about": { + "$ref": "About", + "description": "Optional. The about page URI and state for this country." + }, + "inventoryVerification": { + "$ref": "InventoryVerification", + "description": "Optional. The inventory verification process state for this country." + }, + "lfpLink": { + "$ref": "LfpLink", + "description": "Output only. The established link to a LFP provider.", + "readOnly": true + }, + "lsfType": { + "$ref": "LsfType", + "description": "Optional. The Local Store Front ([LSF](https://support.google.com/merchants/answer/7178526)) type and state for this country." + }, + "name": { + "description": "Identifier. The resource name of the omnichannel setting. Format: `accounts/{account}/omnichannelSettings/{omnichannel_setting}`", + "type": "string" + }, + "odo": { + "$ref": "OnDisplayToOrder", + "description": "Optional. The on display to order (ODO) policy URI and state for this country." + }, + "pickupTypes": { + "description": "Optional. The Pickup types asnd state for this country.", + "items": { + "$ref": "PickupType" + }, + "type": "array" + }, + "regionCode": { + "description": "Immutable. Region code defined by [CLDR](https://cldr.unicode.org/).", + "type": "string" + }, + "state": { + "description": "Output only. The state of the omnichannel setting.", + "enum": [ + "STATE_UNSPECIFIED", + "ACTIVE", + "ACTION_REQUIRED", + "RUNNING" + ], + "enumDescriptions": [ + "Default value. This value is unused.", + "The merchant's omnichannel setting is active.", + "The merchant's omnichannel setting requires action.", + "The merchant's omnichannel setting is running." + ], + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "OnDisplayToOrder": { + "description": "Collection of information related to the on display to order ([ODO](https://support.google.com/merchants/answer/14615056?hl=en\u0026ref_topic=15145747\u0026sjid=6892280366904591178-NC)).", + "id": "OnDisplayToOrder", + "properties": { + "state": { + "description": "Output only. The state of the URI.", + "enum": [ + "STATE_UNSPECIFIED", + "ACTIVE", + "FAILED", + "RUNNING" + ], + "enumDescriptions": [ + "Default value. This value is unused.", + "The review process is active.", + "The review process failed.", + "The review process is running." + ], + "readOnly": true, + "type": "string" + }, + "uri": { + "description": "Required. The on display to order (ODO) policy URI.", + "type": "string" + } + }, + "type": "object" + }, "OnlineReturnPolicy": { "description": "[Online return policy](https://support.google.com/merchants/answer/10220642) object. This is currently used to represent return policies for ads and free listings programs.", "id": "OnlineReturnPolicy", @@ -2513,6 +3199,44 @@ }, "type": "object" }, + "PickupType": { + "description": "Collection of information related to the pickup type.", + "id": "PickupType", + "properties": { + "pickupType": { + "description": "Required. The type of the pickup.", + "enum": [ + "TYPE_UNSPECIFIED", + "PICKUP_TODAY", + "PICKUP_LATER" + ], + "enumDescriptions": [ + "Default value. This value is unused.", + "[Pickup today](https://support.google.com/merchants/answer/14634281?hl=en\u0026ref_topic=15145747\u0026sjid=6892280366904591178-NC#).", + "[Pickup later](https://support.google.com/merchants/answer/14634020?hl=en\u0026ref_topic=15145747\u0026sjid=6892280366904591178-NC#)." + ], + "type": "string" + }, + "state": { + "description": "Output only. The state of the PickupType.", + "enum": [ + "STATE_UNSPECIFIED", + "ACTIVE", + "FAILED", + "RUNNING" + ], + "enumDescriptions": [ + "Default value. This value is unused.", + "The review process is active.", + "The review process failed.", + "The review process is running." + ], + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, "Policy": { "description": "The available policies.", "id": "Policy", @@ -2683,7 +3407,8 @@ "CLOUD_RETAIL", "LOCAL_CLOUD_RETAIL", "PRODUCT_REVIEWS", - "MERCHANT_REVIEWS" + "MERCHANT_REVIEWS", + "YOUTUBE_CHECKOUT" ], "enumDeprecated": [ false, @@ -2702,6 +3427,7 @@ false, false, false, + false, false ], "enumDescriptions": [ @@ -2721,7 +3447,8 @@ "[Cloud retail](https://cloud.google.com/solutions/retail).", "[Local cloud retail](https://cloud.google.com/solutions/retail).", "[Product Reviews](https://support.google.com/merchants/answer/14620732).", - "[Merchant Reviews](https://developers.google.com/merchant-review-feeds)." + "[Merchant Reviews](https://developers.google.com/merchant-review-feeds).", + "[YouTube Checkout](" ], "type": "string" } @@ -2909,6 +3636,23 @@ }, "type": "object" }, + "RequestInventoryVerificationRequest": { + "description": "Request message for the RequestInventoryVerification method.", + "id": "RequestInventoryVerificationRequest", + "properties": {}, + "type": "object" + }, + "RequestInventoryVerificationResponse": { + "description": "Response message for the RequestInventoryVerification method.", + "id": "RequestInventoryVerificationResponse", + "properties": { + "omnichannelSetting": { + "$ref": "OmnichannelSetting", + "description": "The omnichannel setting that was updated." + } + }, + "type": "object" + }, "Required": { "description": "Describes the terms of service which are required to be accepted.", "id": "Required", diff --git a/merchantapi/accounts_v1beta/merchantapi-gen.go b/merchantapi/accounts_v1beta/merchantapi-gen.go index 4e60c4284d3..cb85ee207b2 100644 --- a/merchantapi/accounts_v1beta/merchantapi-gen.go +++ b/merchantapi/accounts_v1beta/merchantapi-gen.go @@ -164,6 +164,7 @@ func NewAccountsService(s *APIService) *AccountsService { rs.EmailPreferences = NewAccountsEmailPreferencesService(s) rs.Homepage = NewAccountsHomepageService(s) rs.Issues = NewAccountsIssuesService(s) + rs.OmnichannelSettings = NewAccountsOmnichannelSettingsService(s) rs.OnlineReturnPolicies = NewAccountsOnlineReturnPoliciesService(s) rs.Programs = NewAccountsProgramsService(s) rs.Regions = NewAccountsRegionsService(s) @@ -188,6 +189,8 @@ type AccountsService struct { Issues *AccountsIssuesService + OmnichannelSettings *AccountsOmnichannelSettingsService + OnlineReturnPolicies *AccountsOnlineReturnPoliciesService Programs *AccountsProgramsService @@ -255,6 +258,39 @@ type AccountsIssuesService struct { s *APIService } +func NewAccountsOmnichannelSettingsService(s *APIService) *AccountsOmnichannelSettingsService { + rs := &AccountsOmnichannelSettingsService{s: s} + rs.GbpAccounts = NewAccountsOmnichannelSettingsGbpAccountsService(s) + rs.LfpProviders = NewAccountsOmnichannelSettingsLfpProvidersService(s) + return rs +} + +type AccountsOmnichannelSettingsService struct { + s *APIService + + GbpAccounts *AccountsOmnichannelSettingsGbpAccountsService + + LfpProviders *AccountsOmnichannelSettingsLfpProvidersService +} + +func NewAccountsOmnichannelSettingsGbpAccountsService(s *APIService) *AccountsOmnichannelSettingsGbpAccountsService { + rs := &AccountsOmnichannelSettingsGbpAccountsService{s: s} + return rs +} + +type AccountsOmnichannelSettingsGbpAccountsService struct { + s *APIService +} + +func NewAccountsOmnichannelSettingsLfpProvidersService(s *APIService) *AccountsOmnichannelSettingsLfpProvidersService { + rs := &AccountsOmnichannelSettingsLfpProvidersService{s: s} + return rs +} + +type AccountsOmnichannelSettingsLfpProvidersService struct { + s *APIService +} + func NewAccountsOnlineReturnPoliciesService(s *APIService) *AccountsOnlineReturnPoliciesService { rs := &AccountsOnlineReturnPoliciesService{s: s} return rs @@ -318,6 +354,37 @@ type TermsOfServiceService struct { s *APIService } +// About: Collection of information related to the about page (impressum +// (https://support.google.com/merchants/answer/14675634?hl=en&ref_topic=15145634&sjid=6892280366904591178-NC)). +type About struct { + // State: Output only. The state of the URI. + // + // Possible values: + // "STATE_UNSPECIFIED" - Default value. This value is unused. + // "ACTIVE" - The review process is active. + // "FAILED" - The review process failed. + // "RUNNING" - The review process is running. + State string `json:"state,omitempty"` + // Uri: Required. The about page URI. + Uri string `json:"uri,omitempty"` + // ForceSendFields is a list of field names (e.g. "State") to unconditionally + // include in API requests. By default, fields with empty or default values are + // omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more + // details. + ForceSendFields []string `json:"-"` + // NullFields is a list of field names (e.g. "State") to include in API + // requests with the JSON null value. By default, fields with empty values are + // omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details. + NullFields []string `json:"-"` +} + +func (s About) MarshalJSON() ([]byte, error) { + type NoMethod About + return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) +} + // Accepted: Describes the accepted terms of service. type Accepted struct { // AcceptedBy: The account where the acceptance was recorded. This can be the @@ -647,10 +714,7 @@ func (s BusinessIdentity) MarshalJSON() ([]byte, error) { return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) } -// BusinessInfo: The `BusinessInfo` message contains essential information -// about a merchant's business. This message captures key business details such -// as physical address, customer service contacts, and region-specific -// identifiers. +// BusinessInfo: Collection of information related to a business. type BusinessInfo struct { // Address: Optional. The address of the business. Only `region_code`, // `address_lines`, `postal_code`, `administrative_area` and `locality` fields @@ -1092,6 +1156,47 @@ type Empty struct { type EnableProgramRequest struct { } +// GbpAccount: Collection of information related to a Google Business Profile +// (GBP) account. +type GbpAccount struct { + // Email: The email which identifies the Business Profile. + Email string `json:"email,omitempty"` + // GbpAccountId: The id of the GBP account. + GbpAccountId string `json:"gbpAccountId,omitempty"` + // GbpAccountName: The name of the Business Profile. For personal accounts: + // Email id of the owner. For Business accounts: Name of the Business Account. + GbpAccountName string `json:"gbpAccountName,omitempty"` + // ListingCount: Number of listings under this account. + ListingCount int64 `json:"listingCount,omitempty,string"` + // Name: Identifier. The resource name of the GBP account. Format: + // `accounts/{account}/omnichannelSettings/{omnichannel_setting}/gbpAccount/{gbp + // _account}` + Name string `json:"name,omitempty"` + // Type: The type of the Business Profile. + // + // Possible values: + // "TYPE_UNSPECIFIED" - Default value. This value is unused. + // "USER" - The GBP account is a user account. + // "BUSINESS_ACCOUNT" - The GBP account is a business account. + Type string `json:"type,omitempty"` + // ForceSendFields is a list of field names (e.g. "Email") to unconditionally + // include in API requests. By default, fields with empty or default values are + // omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more + // details. + ForceSendFields []string `json:"-"` + // NullFields is a list of field names (e.g. "Email") to include in API + // requests with the JSON null value. By default, fields with empty values are + // omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details. + NullFields []string `json:"-"` +} + +func (s GbpAccount) MarshalJSON() ([]byte, error) { + type NoMethod GbpAccount + return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) +} + // GeoTargetArea: A list of geotargets that defines the region area. type GeoTargetArea struct { // GeotargetCriteriaIds: Required. A non-empty list of location IDs @@ -1169,13 +1274,7 @@ func (s Headers) MarshalJSON() ([]byte, error) { return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) } -// Homepage: The `Homepage` message represents a merchant's store homepage -// within the system. A merchant's homepage is the primary domain where -// customers interact with their store. The homepage can be claimed and -// verified as a proof of ownership and allows the merchant to unlock features -// that require a verified website. For more information, see Understanding -// online store URL verification -// (//support.google.com/merchants/answer/176793). +// Homepage: A store's homepage. type Homepage struct { // Claimed: Output only. Whether the homepage is claimed. See // https://support.google.com/merchants/answer/176793. @@ -1309,6 +1408,7 @@ type ImpactedDestination struct { // Reviews](https://support.google.com/merchants/answer/14620732). // "MERCHANT_REVIEWS" - [Merchant // Reviews](https://developers.google.com/merchant-review-feeds). + // "YOUTUBE_CHECKOUT" - [YouTube Checkout]( ReportingContext string `json:"reportingContext,omitempty"` // ForceSendFields is a list of field names (e.g. "Impacts") to unconditionally // include in API requests. By default, fields with empty or default values are @@ -1328,6 +1428,207 @@ func (s ImpactedDestination) MarshalJSON() ([]byte, error) { return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) } +// InventoryVerification: Collection of information related to inventory +// verification +// (https://support.google.com/merchants/answer/14684499?hl=en&ref_topic=15145634&sjid=6892280366904591178-NC). +type InventoryVerification struct { + // Contact: Required. The name of the contact for the inventory verification + // process. + Contact string `json:"contact,omitempty"` + // ContactEmail: Required. The email address of the contact for the inventory + // verification process. + ContactEmail string `json:"contactEmail,omitempty"` + // ContactState: Output only. The state of the contact verification. + // + // Possible values: + // "STATE_UNSPECIFIED" - Default value. This value is unused. + // "ACTIVE" - The review process is active. + // "FAILED" - The review process failed. + // "RUNNING" - The review process is running. + ContactState string `json:"contactState,omitempty"` + // State: Output only. The state of the inventory verification process. + // + // Possible values: + // "STATE_UNSPECIFIED" - Default value. This value is unused. + // "ACTION_REQUIRED" - When merchant fails the inventory verification + // process, but still have remaining attempts. + // "RUNNING" - The inventory verification process is running. + // "SUCCEEDED" - The inventory verification process succeeded. + // "SUSPENDED" - When merchant fails the inventory verification process and + // all attempts are exhausted. + State string `json:"state,omitempty"` + // ForceSendFields is a list of field names (e.g. "Contact") to unconditionally + // include in API requests. By default, fields with empty or default values are + // omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more + // details. + ForceSendFields []string `json:"-"` + // NullFields is a list of field names (e.g. "Contact") to include in API + // requests with the JSON null value. By default, fields with empty values are + // omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details. + NullFields []string `json:"-"` +} + +func (s InventoryVerification) MarshalJSON() ([]byte, error) { + type NoMethod InventoryVerification + return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) +} + +// LfpLink: Collection of information related to the LFP link. +type LfpLink struct { + // ExternalAccountId: Required. The account ID by which this merchant is known + // to the LFP provider. + ExternalAccountId string `json:"externalAccountId,omitempty"` + // ProviderId: Required. The ID of the LFP provider. + ProviderId string `json:"providerId,omitempty"` + // ForceSendFields is a list of field names (e.g. "ExternalAccountId") to + // unconditionally include in API requests. By default, fields with empty or + // default values are omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more + // details. + ForceSendFields []string `json:"-"` + // NullFields is a list of field names (e.g. "ExternalAccountId") to include in + // API requests with the JSON null value. By default, fields with empty values + // are omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details. + NullFields []string `json:"-"` +} + +func (s LfpLink) MarshalJSON() ([]byte, error) { + type NoMethod LfpLink + return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) +} + +// LfpProvider: Collection of information related to a Local Feed Partnership +// (LFP) provider. +type LfpProvider struct { + // DisplayName: The display name of the LFP provider. + DisplayName string `json:"displayName,omitempty"` + // LfpProviderId: The ID of the LFP provider. + LfpProviderId string `json:"lfpProviderId,omitempty"` + // Name: Identifier. The resource name of the LFP provider. Format: + // `accounts/{account}/omnichannelSettings/{omnichannel_setting}/lfpProviders/{l + // fp_provider}` + Name string `json:"name,omitempty"` + // RegionCode: Output only. Region code defined by CLDR + // (https://cldr.unicode.org/). + RegionCode string `json:"regionCode,omitempty"` + // ForceSendFields is a list of field names (e.g. "DisplayName") to + // unconditionally include in API requests. By default, fields with empty or + // default values are omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more + // details. + ForceSendFields []string `json:"-"` + // NullFields is a list of field names (e.g. "DisplayName") to include in API + // requests with the JSON null value. By default, fields with empty values are + // omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details. + NullFields []string `json:"-"` +} + +func (s LfpProvider) MarshalJSON() ([]byte, error) { + type NoMethod LfpProvider + return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) +} + +// LinkGbpAccountRequest: Request message for the LinkGbpAccount method. +type LinkGbpAccountRequest struct { + // GbpEmail: Required. The email address of the Business Profile account. + GbpEmail string `json:"gbpEmail,omitempty"` + // ForceSendFields is a list of field names (e.g. "GbpEmail") to + // unconditionally include in API requests. By default, fields with empty or + // default values are omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more + // details. + ForceSendFields []string `json:"-"` + // NullFields is a list of field names (e.g. "GbpEmail") to include in API + // requests with the JSON null value. By default, fields with empty values are + // omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details. + NullFields []string `json:"-"` +} + +func (s LinkGbpAccountRequest) MarshalJSON() ([]byte, error) { + type NoMethod LinkGbpAccountRequest + return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) +} + +// LinkGbpAccountResponse: Response message for the LinkGbpAccount method. +type LinkGbpAccountResponse struct { + // Response: Empty response. + Response *Empty `json:"response,omitempty"` + + // ServerResponse contains the HTTP response code and headers from the server. + googleapi.ServerResponse `json:"-"` + // ForceSendFields is a list of field names (e.g. "Response") to + // unconditionally include in API requests. By default, fields with empty or + // default values are omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more + // details. + ForceSendFields []string `json:"-"` + // NullFields is a list of field names (e.g. "Response") to include in API + // requests with the JSON null value. By default, fields with empty values are + // omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details. + NullFields []string `json:"-"` +} + +func (s LinkGbpAccountResponse) MarshalJSON() ([]byte, error) { + type NoMethod LinkGbpAccountResponse + return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) +} + +// LinkLfpProviderRequest: Request message for the LinkLfpProvider method. +type LinkLfpProviderRequest struct { + // ExternalAccountId: Required. The external account ID by which this merchant + // is known to the LFP provider. + ExternalAccountId string `json:"externalAccountId,omitempty"` + // LfpProviderId: Required. The id of the LFP provider to link. + LfpProviderId string `json:"lfpProviderId,omitempty"` + // ForceSendFields is a list of field names (e.g. "ExternalAccountId") to + // unconditionally include in API requests. By default, fields with empty or + // default values are omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more + // details. + ForceSendFields []string `json:"-"` + // NullFields is a list of field names (e.g. "ExternalAccountId") to include in + // API requests with the JSON null value. By default, fields with empty values + // are omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details. + NullFields []string `json:"-"` +} + +func (s LinkLfpProviderRequest) MarshalJSON() ([]byte, error) { + type NoMethod LinkLfpProviderRequest + return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) +} + +// LinkLfpProviderResponse: Response message for the LinkLfpProvider method. +type LinkLfpProviderResponse struct { + // Response: Empty response. + Response *Empty `json:"response,omitempty"` + + // ServerResponse contains the HTTP response code and headers from the server. + googleapi.ServerResponse `json:"-"` + // ForceSendFields is a list of field names (e.g. "Response") to + // unconditionally include in API requests. By default, fields with empty or + // default values are omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more + // details. + ForceSendFields []string `json:"-"` + // NullFields is a list of field names (e.g. "Response") to include in API + // requests with the JSON null value. By default, fields with empty values are + // omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details. + NullFields []string `json:"-"` +} + +func (s LinkLfpProviderResponse) MarshalJSON() ([]byte, error) { + type NoMethod LinkLfpProviderResponse + return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) +} + // ListAccountIssuesResponse: Response message for the `ListAccountIssues` // method. type ListAccountIssuesResponse struct { @@ -1385,6 +1686,93 @@ func (s ListAccountsResponse) MarshalJSON() ([]byte, error) { return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) } +// ListGbpAccountsResponse: Response message for the ListGbpAccounts method. +type ListGbpAccountsResponse struct { + // GbpAccounts: The GBP accounts from the specified merchant in the specified + // country. + GbpAccounts []*GbpAccount `json:"gbpAccounts,omitempty"` + // NextPageToken: A token, which can be sent as `page_token` to retrieve the + // next page. If this field is omitted, there are no subsequent pages. + NextPageToken string `json:"nextPageToken,omitempty"` + + // ServerResponse contains the HTTP response code and headers from the server. + googleapi.ServerResponse `json:"-"` + // ForceSendFields is a list of field names (e.g. "GbpAccounts") to + // unconditionally include in API requests. By default, fields with empty or + // default values are omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more + // details. + ForceSendFields []string `json:"-"` + // NullFields is a list of field names (e.g. "GbpAccounts") to include in API + // requests with the JSON null value. By default, fields with empty values are + // omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details. + NullFields []string `json:"-"` +} + +func (s ListGbpAccountsResponse) MarshalJSON() ([]byte, error) { + type NoMethod ListGbpAccountsResponse + return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) +} + +// ListLfpProvidersResponse: Response message for the ListLfpProviders method. +type ListLfpProvidersResponse struct { + // LfpProviders: The LFP providers from the specified merchant in the specified + // country. + LfpProviders []*LfpProvider `json:"lfpProviders,omitempty"` + // NextPageToken: A token, which can be sent as `page_token` to retrieve the + // next page. If this field is omitted, there are no subsequent pages. + NextPageToken string `json:"nextPageToken,omitempty"` + + // ServerResponse contains the HTTP response code and headers from the server. + googleapi.ServerResponse `json:"-"` + // ForceSendFields is a list of field names (e.g. "LfpProviders") to + // unconditionally include in API requests. By default, fields with empty or + // default values are omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more + // details. + ForceSendFields []string `json:"-"` + // NullFields is a list of field names (e.g. "LfpProviders") to include in API + // requests with the JSON null value. By default, fields with empty values are + // omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details. + NullFields []string `json:"-"` +} + +func (s ListLfpProvidersResponse) MarshalJSON() ([]byte, error) { + type NoMethod ListLfpProvidersResponse + return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) +} + +// ListOmnichannelSettingsResponse: Response message for the +// ListOmnichannelSettings method. +type ListOmnichannelSettingsResponse struct { + // NextPageToken: A token, which can be sent as `page_token` to retrieve the + // next page. If this field is omitted, there are no subsequent pages. + NextPageToken string `json:"nextPageToken,omitempty"` + // OmnichannelSettings: The omnichannel settings from the specified merchant. + OmnichannelSettings []*OmnichannelSetting `json:"omnichannelSettings,omitempty"` + + // ServerResponse contains the HTTP response code and headers from the server. + googleapi.ServerResponse `json:"-"` + // ForceSendFields is a list of field names (e.g. "NextPageToken") to + // unconditionally include in API requests. By default, fields with empty or + // default values are omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more + // details. + ForceSendFields []string `json:"-"` + // NullFields is a list of field names (e.g. "NextPageToken") to include in API + // requests with the JSON null value. By default, fields with empty values are + // omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details. + NullFields []string `json:"-"` +} + +func (s ListOmnichannelSettingsResponse) MarshalJSON() ([]byte, error) { + type NoMethod ListOmnichannelSettingsResponse + return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) +} + // ListOnlineReturnPoliciesResponse: Response message for the // `ListOnlineReturnPolicies` method. type ListOnlineReturnPoliciesResponse struct { @@ -1630,22 +2018,59 @@ func (s LoyaltyProgramTiers) MarshalJSON() ([]byte, error) { return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) } -// MinimumOrderValueTable: Table of per store minimum order values for the -// pickup fulfillment type. -type MinimumOrderValueTable struct { - // StoreCodeSetWithMovs: Required. A list of store code sets sharing the same - // minimum order value (MOV). At least two sets are required and the last one - // must be empty, which signifies 'MOV for all other stores'. Each store code - // can only appear once across all the sets. All prices within a service must - // have the same currency. - StoreCodeSetWithMovs []*StoreCodeSetWithMov `json:"storeCodeSetWithMovs,omitempty"` - // ForceSendFields is a list of field names (e.g. "StoreCodeSetWithMovs") to - // unconditionally include in API requests. By default, fields with empty or - // default values are omitted from API requests. See - // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more - // details. - ForceSendFields []string `json:"-"` - // NullFields is a list of field names (e.g. "StoreCodeSetWithMovs") to include +// LsfType: Collection of information related to the Local Store Front (LSF) +// type. +type LsfType struct { + // LsfType: Required. The Local Store Front (LSF) type. + // + // Possible values: + // "TYPE_UNSPECIFIED" - Default value. This value is unused. + // "GHLSF" - Google-Hosted Local Store Front. + // "MHLSF_BASIC" - Merchant-Hosted Local Store Front Basic. + // "MHLSF_FULL" - Merchant-Hosted Local Store Front Full. + LsfType string `json:"lsfType,omitempty"` + // State: Output only. The state of the LSF. + // + // Possible values: + // "STATE_UNSPECIFIED" - Default value. This value is unused. + // "ACTIVE" - The review process is active. + // "FAILED" - The review process failed. + // "RUNNING" - The review process is running. + State string `json:"state,omitempty"` + // ForceSendFields is a list of field names (e.g. "LsfType") to unconditionally + // include in API requests. By default, fields with empty or default values are + // omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more + // details. + ForceSendFields []string `json:"-"` + // NullFields is a list of field names (e.g. "LsfType") to include in API + // requests with the JSON null value. By default, fields with empty values are + // omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details. + NullFields []string `json:"-"` +} + +func (s LsfType) MarshalJSON() ([]byte, error) { + type NoMethod LsfType + return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) +} + +// MinimumOrderValueTable: Table of per store minimum order values for the +// pickup fulfillment type. +type MinimumOrderValueTable struct { + // StoreCodeSetWithMovs: Required. A list of store code sets sharing the same + // minimum order value (MOV). At least two sets are required and the last one + // must be empty, which signifies 'MOV for all other stores'. Each store code + // can only appear once across all the sets. All prices within a service must + // have the same currency. + StoreCodeSetWithMovs []*StoreCodeSetWithMov `json:"storeCodeSetWithMovs,omitempty"` + // ForceSendFields is a list of field names (e.g. "StoreCodeSetWithMovs") to + // unconditionally include in API requests. By default, fields with empty or + // default values are omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more + // details. + ForceSendFields []string `json:"-"` + // NullFields is a list of field names (e.g. "StoreCodeSetWithMovs") to include // in API requests with the JSON null value. By default, fields with empty // values are omitted from API requests. See // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details. @@ -1657,6 +2082,92 @@ func (s MinimumOrderValueTable) MarshalJSON() ([]byte, error) { return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) } +// OmnichannelSetting: Collection of information related to the omnichannel +// settings of a merchant. +type OmnichannelSetting struct { + // About: Optional. The about page URI and state for this country. + About *About `json:"about,omitempty"` + // InventoryVerification: Optional. The inventory verification process state + // for this country. + InventoryVerification *InventoryVerification `json:"inventoryVerification,omitempty"` + // LfpLink: Output only. The established link to a LFP provider. + LfpLink *LfpLink `json:"lfpLink,omitempty"` + // LsfType: Optional. The Local Store Front (LSF + // (https://support.google.com/merchants/answer/7178526)) type and state for + // this country. + LsfType *LsfType `json:"lsfType,omitempty"` + // Name: Identifier. The resource name of the omnichannel setting. Format: + // `accounts/{account}/omnichannelSettings/{omnichannel_setting}` + Name string `json:"name,omitempty"` + // Odo: Optional. The on display to order (ODO) policy URI and state for this + // country. + Odo *OnDisplayToOrder `json:"odo,omitempty"` + // PickupTypes: Optional. The Pickup types asnd state for this country. + PickupTypes []*PickupType `json:"pickupTypes,omitempty"` + // RegionCode: Immutable. Region code defined by CLDR + // (https://cldr.unicode.org/). + RegionCode string `json:"regionCode,omitempty"` + // State: Output only. The state of the omnichannel setting. + // + // Possible values: + // "STATE_UNSPECIFIED" - Default value. This value is unused. + // "ACTIVE" - The merchant's omnichannel setting is active. + // "ACTION_REQUIRED" - The merchant's omnichannel setting requires action. + // "RUNNING" - The merchant's omnichannel setting is running. + State string `json:"state,omitempty"` + + // ServerResponse contains the HTTP response code and headers from the server. + googleapi.ServerResponse `json:"-"` + // ForceSendFields is a list of field names (e.g. "About") to unconditionally + // include in API requests. By default, fields with empty or default values are + // omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more + // details. + ForceSendFields []string `json:"-"` + // NullFields is a list of field names (e.g. "About") to include in API + // requests with the JSON null value. By default, fields with empty values are + // omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details. + NullFields []string `json:"-"` +} + +func (s OmnichannelSetting) MarshalJSON() ([]byte, error) { + type NoMethod OmnichannelSetting + return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) +} + +// OnDisplayToOrder: Collection of information related to the on display to +// order (ODO +// (https://support.google.com/merchants/answer/14615056?hl=en&ref_topic=15145747&sjid=6892280366904591178-NC)). +type OnDisplayToOrder struct { + // State: Output only. The state of the URI. + // + // Possible values: + // "STATE_UNSPECIFIED" - Default value. This value is unused. + // "ACTIVE" - The review process is active. + // "FAILED" - The review process failed. + // "RUNNING" - The review process is running. + State string `json:"state,omitempty"` + // Uri: Required. The on display to order (ODO) policy URI. + Uri string `json:"uri,omitempty"` + // ForceSendFields is a list of field names (e.g. "State") to unconditionally + // include in API requests. By default, fields with empty or default values are + // omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more + // details. + ForceSendFields []string `json:"-"` + // NullFields is a list of field names (e.g. "State") to include in API + // requests with the JSON null value. By default, fields with empty values are + // omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details. + NullFields []string `json:"-"` +} + +func (s OnDisplayToOrder) MarshalJSON() ([]byte, error) { + type NoMethod OnDisplayToOrder + return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) +} + // OnlineReturnPolicy: Online return policy // (https://support.google.com/merchants/answer/10220642) object. This is // currently used to represent return policies for ads and free listings @@ -1795,6 +2306,45 @@ func (s PhoneNumber) MarshalJSON() ([]byte, error) { return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) } +// PickupType: Collection of information related to the pickup type. +type PickupType struct { + // PickupType: Required. The type of the pickup. + // + // Possible values: + // "TYPE_UNSPECIFIED" - Default value. This value is unused. + // "PICKUP_TODAY" - [Pickup + // today](https://support.google.com/merchants/answer/14634281?hl=en&ref_topic=1 + // 5145747&sjid=6892280366904591178-NC#). + // "PICKUP_LATER" - [Pickup + // later](https://support.google.com/merchants/answer/14634020?hl=en&ref_topic=1 + // 5145747&sjid=6892280366904591178-NC#). + PickupType string `json:"pickupType,omitempty"` + // State: Output only. The state of the PickupType. + // + // Possible values: + // "STATE_UNSPECIFIED" - Default value. This value is unused. + // "ACTIVE" - The review process is active. + // "FAILED" - The review process failed. + // "RUNNING" - The review process is running. + State string `json:"state,omitempty"` + // ForceSendFields is a list of field names (e.g. "PickupType") to + // unconditionally include in API requests. By default, fields with empty or + // default values are omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more + // details. + ForceSendFields []string `json:"-"` + // NullFields is a list of field names (e.g. "PickupType") to include in API + // requests with the JSON null value. By default, fields with empty values are + // omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details. + NullFields []string `json:"-"` +} + +func (s PickupType) MarshalJSON() ([]byte, error) { + type NoMethod PickupType + return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) +} + // Policy: The available policies. type Policy struct { // Days: The number of days items can be returned after delivery, where one day @@ -2059,6 +2609,7 @@ type ProductChange struct { // Reviews](https://support.google.com/merchants/answer/14620732). // "MERCHANT_REVIEWS" - [Merchant // Reviews](https://developers.google.com/merchant-review-feeds). + // "YOUTUBE_CHECKOUT" - [YouTube Checkout]( ReportingContext string `json:"reportingContext,omitempty"` // ForceSendFields is a list of field names (e.g. "NewValue") to // unconditionally include in API requests. By default, fields with empty or @@ -2269,6 +2820,37 @@ func (s Region) MarshalJSON() ([]byte, error) { return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) } +// RequestInventoryVerificationRequest: Request message for the +// RequestInventoryVerification method. +type RequestInventoryVerificationRequest struct { +} + +// RequestInventoryVerificationResponse: Response message for the +// RequestInventoryVerification method. +type RequestInventoryVerificationResponse struct { + // OmnichannelSetting: The omnichannel setting that was updated. + OmnichannelSetting *OmnichannelSetting `json:"omnichannelSetting,omitempty"` + + // ServerResponse contains the HTTP response code and headers from the server. + googleapi.ServerResponse `json:"-"` + // ForceSendFields is a list of field names (e.g. "OmnichannelSetting") to + // unconditionally include in API requests. By default, fields with empty or + // default values are omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more + // details. + ForceSendFields []string `json:"-"` + // NullFields is a list of field names (e.g. "OmnichannelSetting") to include + // in API requests with the JSON null value. By default, fields with empty + // values are omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details. + NullFields []string `json:"-"` +} + +func (s RequestInventoryVerificationResponse) MarshalJSON() ([]byte, error) { + type NoMethod RequestInventoryVerificationResponse + return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) +} + // Required: Describes the terms of service which are required to be accepted. type Required struct { // TermsOfService: The termsOfService @@ -5317,6 +5899,1093 @@ func (c *AccountsIssuesListCall) Pages(ctx context.Context, f func(*ListAccountI } } +type AccountsOmnichannelSettingsCreateCall struct { + s *APIService + parent string + omnichannelsetting *OmnichannelSetting + urlParams_ gensupport.URLParams + ctx_ context.Context + header_ http.Header +} + +// Create: Create the omnichannel settings for a given merchant. +// +// - parent: The parent resource where this omnichannel setting will be +// created. Format: `accounts/{account}`. +func (r *AccountsOmnichannelSettingsService) Create(parent string, omnichannelsetting *OmnichannelSetting) *AccountsOmnichannelSettingsCreateCall { + c := &AccountsOmnichannelSettingsCreateCall{s: r.s, urlParams_: make(gensupport.URLParams)} + c.parent = parent + c.omnichannelsetting = omnichannelsetting + return c +} + +// Fields allows partial responses to be retrieved. See +// https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more +// details. +func (c *AccountsOmnichannelSettingsCreateCall) Fields(s ...googleapi.Field) *AccountsOmnichannelSettingsCreateCall { + c.urlParams_.Set("fields", googleapi.CombineFields(s)) + return c +} + +// Context sets the context to be used in this call's Do method. +func (c *AccountsOmnichannelSettingsCreateCall) Context(ctx context.Context) *AccountsOmnichannelSettingsCreateCall { + c.ctx_ = ctx + return c +} + +// Header returns a http.Header that can be modified by the caller to add +// headers to the request. +func (c *AccountsOmnichannelSettingsCreateCall) Header() http.Header { + if c.header_ == nil { + c.header_ = make(http.Header) + } + return c.header_ +} + +func (c *AccountsOmnichannelSettingsCreateCall) doRequest(alt string) (*http.Response, error) { + reqHeaders := gensupport.SetHeaders(c.s.userAgent(), "application/json", c.header_) + var body io.Reader = nil + body, err := googleapi.WithoutDataWrapper.JSONReader(c.omnichannelsetting) + if err != nil { + return nil, err + } + c.urlParams_.Set("alt", alt) + c.urlParams_.Set("prettyPrint", "false") + urls := googleapi.ResolveRelative(c.s.BasePath, "accounts/v1beta/{+parent}/omnichannelSettings") + urls += "?" + c.urlParams_.Encode() + req, err := http.NewRequest("POST", urls, body) + if err != nil { + return nil, err + } + req.Header = reqHeaders + googleapi.Expand(req.URL, map[string]string{ + "parent": c.parent, + }) + return gensupport.SendRequest(c.ctx_, c.s.client, req) +} + +// Do executes the "merchantapi.accounts.omnichannelSettings.create" call. +// Any non-2xx status code is an error. Response headers are in either +// *OmnichannelSetting.ServerResponse.Header or (if a response was returned at +// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to +// check whether the returned error was because http.StatusNotModified was +// returned. +func (c *AccountsOmnichannelSettingsCreateCall) Do(opts ...googleapi.CallOption) (*OmnichannelSetting, error) { + gensupport.SetOptions(c.urlParams_, opts...) + res, err := c.doRequest("json") + if res != nil && res.StatusCode == http.StatusNotModified { + if res.Body != nil { + res.Body.Close() + } + return nil, gensupport.WrapError(&googleapi.Error{ + Code: res.StatusCode, + Header: res.Header, + }) + } + if err != nil { + return nil, err + } + defer googleapi.CloseBody(res) + if err := googleapi.CheckResponse(res); err != nil { + return nil, gensupport.WrapError(err) + } + ret := &OmnichannelSetting{ + ServerResponse: googleapi.ServerResponse{ + Header: res.Header, + HTTPStatusCode: res.StatusCode, + }, + } + target := &ret + if err := gensupport.DecodeResponse(target, res); err != nil { + return nil, err + } + return ret, nil +} + +type AccountsOmnichannelSettingsGetCall struct { + s *APIService + name string + urlParams_ gensupport.URLParams + ifNoneMatch_ string + ctx_ context.Context + header_ http.Header +} + +// Get: Get the omnichannel settings for a given merchant. +// +// - name: The name of the omnichannel setting to retrieve. Format: +// `accounts/{account}/omnichannelSettings/{omnichannel_setting}`. +func (r *AccountsOmnichannelSettingsService) Get(name string) *AccountsOmnichannelSettingsGetCall { + c := &AccountsOmnichannelSettingsGetCall{s: r.s, urlParams_: make(gensupport.URLParams)} + c.name = name + return c +} + +// Fields allows partial responses to be retrieved. See +// https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more +// details. +func (c *AccountsOmnichannelSettingsGetCall) Fields(s ...googleapi.Field) *AccountsOmnichannelSettingsGetCall { + c.urlParams_.Set("fields", googleapi.CombineFields(s)) + return c +} + +// IfNoneMatch sets an optional parameter which makes the operation fail if the +// object's ETag matches the given value. This is useful for getting updates +// only after the object has changed since the last request. +func (c *AccountsOmnichannelSettingsGetCall) IfNoneMatch(entityTag string) *AccountsOmnichannelSettingsGetCall { + c.ifNoneMatch_ = entityTag + return c +} + +// Context sets the context to be used in this call's Do method. +func (c *AccountsOmnichannelSettingsGetCall) Context(ctx context.Context) *AccountsOmnichannelSettingsGetCall { + c.ctx_ = ctx + return c +} + +// Header returns a http.Header that can be modified by the caller to add +// headers to the request. +func (c *AccountsOmnichannelSettingsGetCall) Header() http.Header { + if c.header_ == nil { + c.header_ = make(http.Header) + } + return c.header_ +} + +func (c *AccountsOmnichannelSettingsGetCall) doRequest(alt string) (*http.Response, error) { + reqHeaders := gensupport.SetHeaders(c.s.userAgent(), "", c.header_) + if c.ifNoneMatch_ != "" { + reqHeaders.Set("If-None-Match", c.ifNoneMatch_) + } + var body io.Reader = nil + c.urlParams_.Set("alt", alt) + c.urlParams_.Set("prettyPrint", "false") + urls := googleapi.ResolveRelative(c.s.BasePath, "accounts/v1beta/{+name}") + urls += "?" + c.urlParams_.Encode() + req, err := http.NewRequest("GET", urls, body) + if err != nil { + return nil, err + } + req.Header = reqHeaders + googleapi.Expand(req.URL, map[string]string{ + "name": c.name, + }) + return gensupport.SendRequest(c.ctx_, c.s.client, req) +} + +// Do executes the "merchantapi.accounts.omnichannelSettings.get" call. +// Any non-2xx status code is an error. Response headers are in either +// *OmnichannelSetting.ServerResponse.Header or (if a response was returned at +// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to +// check whether the returned error was because http.StatusNotModified was +// returned. +func (c *AccountsOmnichannelSettingsGetCall) Do(opts ...googleapi.CallOption) (*OmnichannelSetting, error) { + gensupport.SetOptions(c.urlParams_, opts...) + res, err := c.doRequest("json") + if res != nil && res.StatusCode == http.StatusNotModified { + if res.Body != nil { + res.Body.Close() + } + return nil, gensupport.WrapError(&googleapi.Error{ + Code: res.StatusCode, + Header: res.Header, + }) + } + if err != nil { + return nil, err + } + defer googleapi.CloseBody(res) + if err := googleapi.CheckResponse(res); err != nil { + return nil, gensupport.WrapError(err) + } + ret := &OmnichannelSetting{ + ServerResponse: googleapi.ServerResponse{ + Header: res.Header, + HTTPStatusCode: res.StatusCode, + }, + } + target := &ret + if err := gensupport.DecodeResponse(target, res); err != nil { + return nil, err + } + return ret, nil +} + +type AccountsOmnichannelSettingsListCall struct { + s *APIService + parent string + urlParams_ gensupport.URLParams + ifNoneMatch_ string + ctx_ context.Context + header_ http.Header +} + +// List: List all the omnichannel settings for a given merchant. +// +// - parent: The parent, which owns this collection of omnichannel settings. +// Format: `accounts/{account}`. +func (r *AccountsOmnichannelSettingsService) List(parent string) *AccountsOmnichannelSettingsListCall { + c := &AccountsOmnichannelSettingsListCall{s: r.s, urlParams_: make(gensupport.URLParams)} + c.parent = parent + return c +} + +// PageSize sets the optional parameter "pageSize": The maximum number of +// omnichannel settings to return. The service may return fewer than this +// value. If unspecified, at most 50 omnichannel settings will be returned. The +// maximum value is 1000; values above 1000 will be coerced to 1000. +func (c *AccountsOmnichannelSettingsListCall) PageSize(pageSize int64) *AccountsOmnichannelSettingsListCall { + c.urlParams_.Set("pageSize", fmt.Sprint(pageSize)) + return c +} + +// PageToken sets the optional parameter "pageToken": A page token, received +// from a previous `ListOmnichannelSettings` call. Provide this to retrieve the +// subsequent page. When paginating, all other parameters provided to +// `ListOmnichannelSettings` must match the call that provided the page token. +func (c *AccountsOmnichannelSettingsListCall) PageToken(pageToken string) *AccountsOmnichannelSettingsListCall { + c.urlParams_.Set("pageToken", pageToken) + return c +} + +// Fields allows partial responses to be retrieved. See +// https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more +// details. +func (c *AccountsOmnichannelSettingsListCall) Fields(s ...googleapi.Field) *AccountsOmnichannelSettingsListCall { + c.urlParams_.Set("fields", googleapi.CombineFields(s)) + return c +} + +// IfNoneMatch sets an optional parameter which makes the operation fail if the +// object's ETag matches the given value. This is useful for getting updates +// only after the object has changed since the last request. +func (c *AccountsOmnichannelSettingsListCall) IfNoneMatch(entityTag string) *AccountsOmnichannelSettingsListCall { + c.ifNoneMatch_ = entityTag + return c +} + +// Context sets the context to be used in this call's Do method. +func (c *AccountsOmnichannelSettingsListCall) Context(ctx context.Context) *AccountsOmnichannelSettingsListCall { + c.ctx_ = ctx + return c +} + +// Header returns a http.Header that can be modified by the caller to add +// headers to the request. +func (c *AccountsOmnichannelSettingsListCall) Header() http.Header { + if c.header_ == nil { + c.header_ = make(http.Header) + } + return c.header_ +} + +func (c *AccountsOmnichannelSettingsListCall) doRequest(alt string) (*http.Response, error) { + reqHeaders := gensupport.SetHeaders(c.s.userAgent(), "", c.header_) + if c.ifNoneMatch_ != "" { + reqHeaders.Set("If-None-Match", c.ifNoneMatch_) + } + var body io.Reader = nil + c.urlParams_.Set("alt", alt) + c.urlParams_.Set("prettyPrint", "false") + urls := googleapi.ResolveRelative(c.s.BasePath, "accounts/v1beta/{+parent}/omnichannelSettings") + urls += "?" + c.urlParams_.Encode() + req, err := http.NewRequest("GET", urls, body) + if err != nil { + return nil, err + } + req.Header = reqHeaders + googleapi.Expand(req.URL, map[string]string{ + "parent": c.parent, + }) + return gensupport.SendRequest(c.ctx_, c.s.client, req) +} + +// Do executes the "merchantapi.accounts.omnichannelSettings.list" call. +// Any non-2xx status code is an error. Response headers are in either +// *ListOmnichannelSettingsResponse.ServerResponse.Header or (if a response was +// returned at all) in error.(*googleapi.Error).Header. Use +// googleapi.IsNotModified to check whether the returned error was because +// http.StatusNotModified was returned. +func (c *AccountsOmnichannelSettingsListCall) Do(opts ...googleapi.CallOption) (*ListOmnichannelSettingsResponse, error) { + gensupport.SetOptions(c.urlParams_, opts...) + res, err := c.doRequest("json") + if res != nil && res.StatusCode == http.StatusNotModified { + if res.Body != nil { + res.Body.Close() + } + return nil, gensupport.WrapError(&googleapi.Error{ + Code: res.StatusCode, + Header: res.Header, + }) + } + if err != nil { + return nil, err + } + defer googleapi.CloseBody(res) + if err := googleapi.CheckResponse(res); err != nil { + return nil, gensupport.WrapError(err) + } + ret := &ListOmnichannelSettingsResponse{ + ServerResponse: googleapi.ServerResponse{ + Header: res.Header, + HTTPStatusCode: res.StatusCode, + }, + } + target := &ret + if err := gensupport.DecodeResponse(target, res); err != nil { + return nil, err + } + return ret, nil +} + +// Pages invokes f for each page of results. +// A non-nil error returned from f will halt the iteration. +// The provided context supersedes any context provided to the Context method. +func (c *AccountsOmnichannelSettingsListCall) Pages(ctx context.Context, f func(*ListOmnichannelSettingsResponse) error) error { + c.ctx_ = ctx + defer c.PageToken(c.urlParams_.Get("pageToken")) + for { + x, err := c.Do() + if err != nil { + return err + } + if err := f(x); err != nil { + return err + } + if x.NextPageToken == "" { + return nil + } + c.PageToken(x.NextPageToken) + } +} + +type AccountsOmnichannelSettingsPatchCall struct { + s *APIService + name string + omnichannelsetting *OmnichannelSetting + urlParams_ gensupport.URLParams + ctx_ context.Context + header_ http.Header +} + +// Patch: Update the omnichannel setting for a given merchant in a given +// country. +// +// - name: Identifier. The resource name of the omnichannel setting. Format: +// `accounts/{account}/omnichannelSettings/{omnichannel_setting}`. +func (r *AccountsOmnichannelSettingsService) Patch(name string, omnichannelsetting *OmnichannelSetting) *AccountsOmnichannelSettingsPatchCall { + c := &AccountsOmnichannelSettingsPatchCall{s: r.s, urlParams_: make(gensupport.URLParams)} + c.name = name + c.omnichannelsetting = omnichannelsetting + return c +} + +// UpdateMask sets the optional parameter "updateMask": The list of fields to +// be updated. +func (c *AccountsOmnichannelSettingsPatchCall) UpdateMask(updateMask string) *AccountsOmnichannelSettingsPatchCall { + c.urlParams_.Set("updateMask", updateMask) + return c +} + +// Fields allows partial responses to be retrieved. See +// https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more +// details. +func (c *AccountsOmnichannelSettingsPatchCall) Fields(s ...googleapi.Field) *AccountsOmnichannelSettingsPatchCall { + c.urlParams_.Set("fields", googleapi.CombineFields(s)) + return c +} + +// Context sets the context to be used in this call's Do method. +func (c *AccountsOmnichannelSettingsPatchCall) Context(ctx context.Context) *AccountsOmnichannelSettingsPatchCall { + c.ctx_ = ctx + return c +} + +// Header returns a http.Header that can be modified by the caller to add +// headers to the request. +func (c *AccountsOmnichannelSettingsPatchCall) Header() http.Header { + if c.header_ == nil { + c.header_ = make(http.Header) + } + return c.header_ +} + +func (c *AccountsOmnichannelSettingsPatchCall) doRequest(alt string) (*http.Response, error) { + reqHeaders := gensupport.SetHeaders(c.s.userAgent(), "application/json", c.header_) + var body io.Reader = nil + body, err := googleapi.WithoutDataWrapper.JSONReader(c.omnichannelsetting) + if err != nil { + return nil, err + } + c.urlParams_.Set("alt", alt) + c.urlParams_.Set("prettyPrint", "false") + urls := googleapi.ResolveRelative(c.s.BasePath, "accounts/v1beta/{+name}") + urls += "?" + c.urlParams_.Encode() + req, err := http.NewRequest("PATCH", urls, body) + if err != nil { + return nil, err + } + req.Header = reqHeaders + googleapi.Expand(req.URL, map[string]string{ + "name": c.name, + }) + return gensupport.SendRequest(c.ctx_, c.s.client, req) +} + +// Do executes the "merchantapi.accounts.omnichannelSettings.patch" call. +// Any non-2xx status code is an error. Response headers are in either +// *OmnichannelSetting.ServerResponse.Header or (if a response was returned at +// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to +// check whether the returned error was because http.StatusNotModified was +// returned. +func (c *AccountsOmnichannelSettingsPatchCall) Do(opts ...googleapi.CallOption) (*OmnichannelSetting, error) { + gensupport.SetOptions(c.urlParams_, opts...) + res, err := c.doRequest("json") + if res != nil && res.StatusCode == http.StatusNotModified { + if res.Body != nil { + res.Body.Close() + } + return nil, gensupport.WrapError(&googleapi.Error{ + Code: res.StatusCode, + Header: res.Header, + }) + } + if err != nil { + return nil, err + } + defer googleapi.CloseBody(res) + if err := googleapi.CheckResponse(res); err != nil { + return nil, gensupport.WrapError(err) + } + ret := &OmnichannelSetting{ + ServerResponse: googleapi.ServerResponse{ + Header: res.Header, + HTTPStatusCode: res.StatusCode, + }, + } + target := &ret + if err := gensupport.DecodeResponse(target, res); err != nil { + return nil, err + } + return ret, nil +} + +type AccountsOmnichannelSettingsRequestInventoryVerificationCall struct { + s *APIService + name string + requestinventoryverificationrequest *RequestInventoryVerificationRequest + urlParams_ gensupport.URLParams + ctx_ context.Context + header_ http.Header +} + +// RequestInventoryVerification: Requests inventory verification for a given +// merchant in a given country. +// +// - name: The name of the omnichannel setting to request inventory +// verification. Format: +// `accounts/{account}/omnichannelSettings/{omnichannel_setting}`. +func (r *AccountsOmnichannelSettingsService) RequestInventoryVerification(name string, requestinventoryverificationrequest *RequestInventoryVerificationRequest) *AccountsOmnichannelSettingsRequestInventoryVerificationCall { + c := &AccountsOmnichannelSettingsRequestInventoryVerificationCall{s: r.s, urlParams_: make(gensupport.URLParams)} + c.name = name + c.requestinventoryverificationrequest = requestinventoryverificationrequest + return c +} + +// Fields allows partial responses to be retrieved. See +// https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more +// details. +func (c *AccountsOmnichannelSettingsRequestInventoryVerificationCall) Fields(s ...googleapi.Field) *AccountsOmnichannelSettingsRequestInventoryVerificationCall { + c.urlParams_.Set("fields", googleapi.CombineFields(s)) + return c +} + +// Context sets the context to be used in this call's Do method. +func (c *AccountsOmnichannelSettingsRequestInventoryVerificationCall) Context(ctx context.Context) *AccountsOmnichannelSettingsRequestInventoryVerificationCall { + c.ctx_ = ctx + return c +} + +// Header returns a http.Header that can be modified by the caller to add +// headers to the request. +func (c *AccountsOmnichannelSettingsRequestInventoryVerificationCall) Header() http.Header { + if c.header_ == nil { + c.header_ = make(http.Header) + } + return c.header_ +} + +func (c *AccountsOmnichannelSettingsRequestInventoryVerificationCall) doRequest(alt string) (*http.Response, error) { + reqHeaders := gensupport.SetHeaders(c.s.userAgent(), "application/json", c.header_) + var body io.Reader = nil + body, err := googleapi.WithoutDataWrapper.JSONReader(c.requestinventoryverificationrequest) + if err != nil { + return nil, err + } + c.urlParams_.Set("alt", alt) + c.urlParams_.Set("prettyPrint", "false") + urls := googleapi.ResolveRelative(c.s.BasePath, "accounts/v1beta/{+name}:requestInventoryVerification") + urls += "?" + c.urlParams_.Encode() + req, err := http.NewRequest("POST", urls, body) + if err != nil { + return nil, err + } + req.Header = reqHeaders + googleapi.Expand(req.URL, map[string]string{ + "name": c.name, + }) + return gensupport.SendRequest(c.ctx_, c.s.client, req) +} + +// Do executes the "merchantapi.accounts.omnichannelSettings.requestInventoryVerification" call. +// Any non-2xx status code is an error. Response headers are in either +// *RequestInventoryVerificationResponse.ServerResponse.Header or (if a +// response was returned at all) in error.(*googleapi.Error).Header. Use +// googleapi.IsNotModified to check whether the returned error was because +// http.StatusNotModified was returned. +func (c *AccountsOmnichannelSettingsRequestInventoryVerificationCall) Do(opts ...googleapi.CallOption) (*RequestInventoryVerificationResponse, error) { + gensupport.SetOptions(c.urlParams_, opts...) + res, err := c.doRequest("json") + if res != nil && res.StatusCode == http.StatusNotModified { + if res.Body != nil { + res.Body.Close() + } + return nil, gensupport.WrapError(&googleapi.Error{ + Code: res.StatusCode, + Header: res.Header, + }) + } + if err != nil { + return nil, err + } + defer googleapi.CloseBody(res) + if err := googleapi.CheckResponse(res); err != nil { + return nil, gensupport.WrapError(err) + } + ret := &RequestInventoryVerificationResponse{ + ServerResponse: googleapi.ServerResponse{ + Header: res.Header, + HTTPStatusCode: res.StatusCode, + }, + } + target := &ret + if err := gensupport.DecodeResponse(target, res); err != nil { + return nil, err + } + return ret, nil +} + +type AccountsOmnichannelSettingsGbpAccountsLinkGbpAccountCall struct { + s *APIService + parent string + linkgbpaccountrequest *LinkGbpAccountRequest + urlParams_ gensupport.URLParams + ctx_ context.Context + header_ http.Header +} + +// LinkGbpAccount: Link the specified merchant to a GBP account for all +// countries. +// +// - parent: The name of the parent resource under which the GBP accounts are +// listed. Format: +// `accounts/{account}/omnichannelSettings/{omnichannel_setting}`. +func (r *AccountsOmnichannelSettingsGbpAccountsService) LinkGbpAccount(parent string, linkgbpaccountrequest *LinkGbpAccountRequest) *AccountsOmnichannelSettingsGbpAccountsLinkGbpAccountCall { + c := &AccountsOmnichannelSettingsGbpAccountsLinkGbpAccountCall{s: r.s, urlParams_: make(gensupport.URLParams)} + c.parent = parent + c.linkgbpaccountrequest = linkgbpaccountrequest + return c +} + +// Fields allows partial responses to be retrieved. See +// https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more +// details. +func (c *AccountsOmnichannelSettingsGbpAccountsLinkGbpAccountCall) Fields(s ...googleapi.Field) *AccountsOmnichannelSettingsGbpAccountsLinkGbpAccountCall { + c.urlParams_.Set("fields", googleapi.CombineFields(s)) + return c +} + +// Context sets the context to be used in this call's Do method. +func (c *AccountsOmnichannelSettingsGbpAccountsLinkGbpAccountCall) Context(ctx context.Context) *AccountsOmnichannelSettingsGbpAccountsLinkGbpAccountCall { + c.ctx_ = ctx + return c +} + +// Header returns a http.Header that can be modified by the caller to add +// headers to the request. +func (c *AccountsOmnichannelSettingsGbpAccountsLinkGbpAccountCall) Header() http.Header { + if c.header_ == nil { + c.header_ = make(http.Header) + } + return c.header_ +} + +func (c *AccountsOmnichannelSettingsGbpAccountsLinkGbpAccountCall) doRequest(alt string) (*http.Response, error) { + reqHeaders := gensupport.SetHeaders(c.s.userAgent(), "application/json", c.header_) + var body io.Reader = nil + body, err := googleapi.WithoutDataWrapper.JSONReader(c.linkgbpaccountrequest) + if err != nil { + return nil, err + } + c.urlParams_.Set("alt", alt) + c.urlParams_.Set("prettyPrint", "false") + urls := googleapi.ResolveRelative(c.s.BasePath, "accounts/v1beta/{+parent}/gbpAccounts:linkGbpAccount") + urls += "?" + c.urlParams_.Encode() + req, err := http.NewRequest("POST", urls, body) + if err != nil { + return nil, err + } + req.Header = reqHeaders + googleapi.Expand(req.URL, map[string]string{ + "parent": c.parent, + }) + return gensupport.SendRequest(c.ctx_, c.s.client, req) +} + +// Do executes the "merchantapi.accounts.omnichannelSettings.gbpAccounts.linkGbpAccount" call. +// Any non-2xx status code is an error. Response headers are in either +// *LinkGbpAccountResponse.ServerResponse.Header or (if a response was returned +// at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to +// check whether the returned error was because http.StatusNotModified was +// returned. +func (c *AccountsOmnichannelSettingsGbpAccountsLinkGbpAccountCall) Do(opts ...googleapi.CallOption) (*LinkGbpAccountResponse, error) { + gensupport.SetOptions(c.urlParams_, opts...) + res, err := c.doRequest("json") + if res != nil && res.StatusCode == http.StatusNotModified { + if res.Body != nil { + res.Body.Close() + } + return nil, gensupport.WrapError(&googleapi.Error{ + Code: res.StatusCode, + Header: res.Header, + }) + } + if err != nil { + return nil, err + } + defer googleapi.CloseBody(res) + if err := googleapi.CheckResponse(res); err != nil { + return nil, gensupport.WrapError(err) + } + ret := &LinkGbpAccountResponse{ + ServerResponse: googleapi.ServerResponse{ + Header: res.Header, + HTTPStatusCode: res.StatusCode, + }, + } + target := &ret + if err := gensupport.DecodeResponse(target, res); err != nil { + return nil, err + } + return ret, nil +} + +type AccountsOmnichannelSettingsGbpAccountsListCall struct { + s *APIService + parent string + urlParams_ gensupport.URLParams + ifNoneMatch_ string + ctx_ context.Context + header_ http.Header +} + +// List: List the GBP accounts for a given merchant. +// +// - parent: The name of the parent resource under which the GBP accounts are +// listed. Format: +// `accounts/{account}/omnichannelSettings/{omnichannel_setting}`. +func (r *AccountsOmnichannelSettingsGbpAccountsService) List(parent string) *AccountsOmnichannelSettingsGbpAccountsListCall { + c := &AccountsOmnichannelSettingsGbpAccountsListCall{s: r.s, urlParams_: make(gensupport.URLParams)} + c.parent = parent + return c +} + +// PageSize sets the optional parameter "pageSize": The maximum number of +// `GbpAccount` resources to return. The service returns fewer than this value +// if the number of gbp accounts is less that than the `pageSize`. The default +// value is 50. The maximum value is 1000; If a value higher than the maximum +// is specified, then the `pageSize` will default to the maximum. +func (c *AccountsOmnichannelSettingsGbpAccountsListCall) PageSize(pageSize int64) *AccountsOmnichannelSettingsGbpAccountsListCall { + c.urlParams_.Set("pageSize", fmt.Sprint(pageSize)) + return c +} + +// PageToken sets the optional parameter "pageToken": A page token, received +// from a previous `ListGbpAccounts` call. Provide the page token to retrieve +// the subsequent page. When paginating, all other parameters provided to +// `ListGbpAccounts` must match the call that provided the page token. +func (c *AccountsOmnichannelSettingsGbpAccountsListCall) PageToken(pageToken string) *AccountsOmnichannelSettingsGbpAccountsListCall { + c.urlParams_.Set("pageToken", pageToken) + return c +} + +// Fields allows partial responses to be retrieved. See +// https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more +// details. +func (c *AccountsOmnichannelSettingsGbpAccountsListCall) Fields(s ...googleapi.Field) *AccountsOmnichannelSettingsGbpAccountsListCall { + c.urlParams_.Set("fields", googleapi.CombineFields(s)) + return c +} + +// IfNoneMatch sets an optional parameter which makes the operation fail if the +// object's ETag matches the given value. This is useful for getting updates +// only after the object has changed since the last request. +func (c *AccountsOmnichannelSettingsGbpAccountsListCall) IfNoneMatch(entityTag string) *AccountsOmnichannelSettingsGbpAccountsListCall { + c.ifNoneMatch_ = entityTag + return c +} + +// Context sets the context to be used in this call's Do method. +func (c *AccountsOmnichannelSettingsGbpAccountsListCall) Context(ctx context.Context) *AccountsOmnichannelSettingsGbpAccountsListCall { + c.ctx_ = ctx + return c +} + +// Header returns a http.Header that can be modified by the caller to add +// headers to the request. +func (c *AccountsOmnichannelSettingsGbpAccountsListCall) Header() http.Header { + if c.header_ == nil { + c.header_ = make(http.Header) + } + return c.header_ +} + +func (c *AccountsOmnichannelSettingsGbpAccountsListCall) doRequest(alt string) (*http.Response, error) { + reqHeaders := gensupport.SetHeaders(c.s.userAgent(), "", c.header_) + if c.ifNoneMatch_ != "" { + reqHeaders.Set("If-None-Match", c.ifNoneMatch_) + } + var body io.Reader = nil + c.urlParams_.Set("alt", alt) + c.urlParams_.Set("prettyPrint", "false") + urls := googleapi.ResolveRelative(c.s.BasePath, "accounts/v1beta/{+parent}/gbpAccounts") + urls += "?" + c.urlParams_.Encode() + req, err := http.NewRequest("GET", urls, body) + if err != nil { + return nil, err + } + req.Header = reqHeaders + googleapi.Expand(req.URL, map[string]string{ + "parent": c.parent, + }) + return gensupport.SendRequest(c.ctx_, c.s.client, req) +} + +// Do executes the "merchantapi.accounts.omnichannelSettings.gbpAccounts.list" call. +// Any non-2xx status code is an error. Response headers are in either +// *ListGbpAccountsResponse.ServerResponse.Header or (if a response was +// returned at all) in error.(*googleapi.Error).Header. Use +// googleapi.IsNotModified to check whether the returned error was because +// http.StatusNotModified was returned. +func (c *AccountsOmnichannelSettingsGbpAccountsListCall) Do(opts ...googleapi.CallOption) (*ListGbpAccountsResponse, error) { + gensupport.SetOptions(c.urlParams_, opts...) + res, err := c.doRequest("json") + if res != nil && res.StatusCode == http.StatusNotModified { + if res.Body != nil { + res.Body.Close() + } + return nil, gensupport.WrapError(&googleapi.Error{ + Code: res.StatusCode, + Header: res.Header, + }) + } + if err != nil { + return nil, err + } + defer googleapi.CloseBody(res) + if err := googleapi.CheckResponse(res); err != nil { + return nil, gensupport.WrapError(err) + } + ret := &ListGbpAccountsResponse{ + ServerResponse: googleapi.ServerResponse{ + Header: res.Header, + HTTPStatusCode: res.StatusCode, + }, + } + target := &ret + if err := gensupport.DecodeResponse(target, res); err != nil { + return nil, err + } + return ret, nil +} + +// Pages invokes f for each page of results. +// A non-nil error returned from f will halt the iteration. +// The provided context supersedes any context provided to the Context method. +func (c *AccountsOmnichannelSettingsGbpAccountsListCall) Pages(ctx context.Context, f func(*ListGbpAccountsResponse) error) error { + c.ctx_ = ctx + defer c.PageToken(c.urlParams_.Get("pageToken")) + for { + x, err := c.Do() + if err != nil { + return err + } + if err := f(x); err != nil { + return err + } + if x.NextPageToken == "" { + return nil + } + c.PageToken(x.NextPageToken) + } +} + +type AccountsOmnichannelSettingsLfpProvidersLinkLfpProviderCall struct { + s *APIService + parent string + linklfpproviderrequest *LinkLfpProviderRequest + urlParams_ gensupport.URLParams + ctx_ context.Context + header_ http.Header +} + +// LinkLfpProvider: Link the specified merchant to a LFP provider for the +// specified country. +// +// - parent: The name of the parent resource under which the LFP provider is +// linked. Format: +// `accounts/{account}/omnichannelSettings/{omnichannel_setting}`. +func (r *AccountsOmnichannelSettingsLfpProvidersService) LinkLfpProvider(parent string, linklfpproviderrequest *LinkLfpProviderRequest) *AccountsOmnichannelSettingsLfpProvidersLinkLfpProviderCall { + c := &AccountsOmnichannelSettingsLfpProvidersLinkLfpProviderCall{s: r.s, urlParams_: make(gensupport.URLParams)} + c.parent = parent + c.linklfpproviderrequest = linklfpproviderrequest + return c +} + +// Fields allows partial responses to be retrieved. See +// https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more +// details. +func (c *AccountsOmnichannelSettingsLfpProvidersLinkLfpProviderCall) Fields(s ...googleapi.Field) *AccountsOmnichannelSettingsLfpProvidersLinkLfpProviderCall { + c.urlParams_.Set("fields", googleapi.CombineFields(s)) + return c +} + +// Context sets the context to be used in this call's Do method. +func (c *AccountsOmnichannelSettingsLfpProvidersLinkLfpProviderCall) Context(ctx context.Context) *AccountsOmnichannelSettingsLfpProvidersLinkLfpProviderCall { + c.ctx_ = ctx + return c +} + +// Header returns a http.Header that can be modified by the caller to add +// headers to the request. +func (c *AccountsOmnichannelSettingsLfpProvidersLinkLfpProviderCall) Header() http.Header { + if c.header_ == nil { + c.header_ = make(http.Header) + } + return c.header_ +} + +func (c *AccountsOmnichannelSettingsLfpProvidersLinkLfpProviderCall) doRequest(alt string) (*http.Response, error) { + reqHeaders := gensupport.SetHeaders(c.s.userAgent(), "application/json", c.header_) + var body io.Reader = nil + body, err := googleapi.WithoutDataWrapper.JSONReader(c.linklfpproviderrequest) + if err != nil { + return nil, err + } + c.urlParams_.Set("alt", alt) + c.urlParams_.Set("prettyPrint", "false") + urls := googleapi.ResolveRelative(c.s.BasePath, "accounts/v1beta/{+parent}/lfpProviders:linkLfpProvider") + urls += "?" + c.urlParams_.Encode() + req, err := http.NewRequest("POST", urls, body) + if err != nil { + return nil, err + } + req.Header = reqHeaders + googleapi.Expand(req.URL, map[string]string{ + "parent": c.parent, + }) + return gensupport.SendRequest(c.ctx_, c.s.client, req) +} + +// Do executes the "merchantapi.accounts.omnichannelSettings.lfpProviders.linkLfpProvider" call. +// Any non-2xx status code is an error. Response headers are in either +// *LinkLfpProviderResponse.ServerResponse.Header or (if a response was +// returned at all) in error.(*googleapi.Error).Header. Use +// googleapi.IsNotModified to check whether the returned error was because +// http.StatusNotModified was returned. +func (c *AccountsOmnichannelSettingsLfpProvidersLinkLfpProviderCall) Do(opts ...googleapi.CallOption) (*LinkLfpProviderResponse, error) { + gensupport.SetOptions(c.urlParams_, opts...) + res, err := c.doRequest("json") + if res != nil && res.StatusCode == http.StatusNotModified { + if res.Body != nil { + res.Body.Close() + } + return nil, gensupport.WrapError(&googleapi.Error{ + Code: res.StatusCode, + Header: res.Header, + }) + } + if err != nil { + return nil, err + } + defer googleapi.CloseBody(res) + if err := googleapi.CheckResponse(res); err != nil { + return nil, gensupport.WrapError(err) + } + ret := &LinkLfpProviderResponse{ + ServerResponse: googleapi.ServerResponse{ + Header: res.Header, + HTTPStatusCode: res.StatusCode, + }, + } + target := &ret + if err := gensupport.DecodeResponse(target, res); err != nil { + return nil, err + } + return ret, nil +} + +type AccountsOmnichannelSettingsLfpProvidersListCall struct { + s *APIService + parent string + urlParams_ gensupport.URLParams + ifNoneMatch_ string + ctx_ context.Context + header_ http.Header +} + +// List: List the LFP provider settings for a given merchant in a given +// country. +// +// - parent: The name of the parent resource under which the LFP providers are +// listed. Format: +// `accounts/{account}/omnichannelSettings/{omnichannel_setting}`. +func (r *AccountsOmnichannelSettingsLfpProvidersService) List(parent string) *AccountsOmnichannelSettingsLfpProvidersListCall { + c := &AccountsOmnichannelSettingsLfpProvidersListCall{s: r.s, urlParams_: make(gensupport.URLParams)} + c.parent = parent + return c +} + +// PageSize sets the optional parameter "pageSize": The maximum number of +// `LfpProvider` resources to return. The service returns fewer than this value +// if the number of lfp providers is less that than the `pageSize`. The default +// value is 50. The maximum value is 1000; If a value higher than the maximum +// is specified, then the `pageSize` will default to the maximum. +func (c *AccountsOmnichannelSettingsLfpProvidersListCall) PageSize(pageSize int64) *AccountsOmnichannelSettingsLfpProvidersListCall { + c.urlParams_.Set("pageSize", fmt.Sprint(pageSize)) + return c +} + +// PageToken sets the optional parameter "pageToken": A page token, received +// from a previous `ListLfpProviders` call. Provide the page token to retrieve +// the subsequent page. When paginating, all other parameters provided to +// `ListLfpProviders` must match the call that provided the page token. +func (c *AccountsOmnichannelSettingsLfpProvidersListCall) PageToken(pageToken string) *AccountsOmnichannelSettingsLfpProvidersListCall { + c.urlParams_.Set("pageToken", pageToken) + return c +} + +// Fields allows partial responses to be retrieved. See +// https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more +// details. +func (c *AccountsOmnichannelSettingsLfpProvidersListCall) Fields(s ...googleapi.Field) *AccountsOmnichannelSettingsLfpProvidersListCall { + c.urlParams_.Set("fields", googleapi.CombineFields(s)) + return c +} + +// IfNoneMatch sets an optional parameter which makes the operation fail if the +// object's ETag matches the given value. This is useful for getting updates +// only after the object has changed since the last request. +func (c *AccountsOmnichannelSettingsLfpProvidersListCall) IfNoneMatch(entityTag string) *AccountsOmnichannelSettingsLfpProvidersListCall { + c.ifNoneMatch_ = entityTag + return c +} + +// Context sets the context to be used in this call's Do method. +func (c *AccountsOmnichannelSettingsLfpProvidersListCall) Context(ctx context.Context) *AccountsOmnichannelSettingsLfpProvidersListCall { + c.ctx_ = ctx + return c +} + +// Header returns a http.Header that can be modified by the caller to add +// headers to the request. +func (c *AccountsOmnichannelSettingsLfpProvidersListCall) Header() http.Header { + if c.header_ == nil { + c.header_ = make(http.Header) + } + return c.header_ +} + +func (c *AccountsOmnichannelSettingsLfpProvidersListCall) doRequest(alt string) (*http.Response, error) { + reqHeaders := gensupport.SetHeaders(c.s.userAgent(), "", c.header_) + if c.ifNoneMatch_ != "" { + reqHeaders.Set("If-None-Match", c.ifNoneMatch_) + } + var body io.Reader = nil + c.urlParams_.Set("alt", alt) + c.urlParams_.Set("prettyPrint", "false") + urls := googleapi.ResolveRelative(c.s.BasePath, "accounts/v1beta/{+parent}/lfpProviders") + urls += "?" + c.urlParams_.Encode() + req, err := http.NewRequest("GET", urls, body) + if err != nil { + return nil, err + } + req.Header = reqHeaders + googleapi.Expand(req.URL, map[string]string{ + "parent": c.parent, + }) + return gensupport.SendRequest(c.ctx_, c.s.client, req) +} + +// Do executes the "merchantapi.accounts.omnichannelSettings.lfpProviders.list" call. +// Any non-2xx status code is an error. Response headers are in either +// *ListLfpProvidersResponse.ServerResponse.Header or (if a response was +// returned at all) in error.(*googleapi.Error).Header. Use +// googleapi.IsNotModified to check whether the returned error was because +// http.StatusNotModified was returned. +func (c *AccountsOmnichannelSettingsLfpProvidersListCall) Do(opts ...googleapi.CallOption) (*ListLfpProvidersResponse, error) { + gensupport.SetOptions(c.urlParams_, opts...) + res, err := c.doRequest("json") + if res != nil && res.StatusCode == http.StatusNotModified { + if res.Body != nil { + res.Body.Close() + } + return nil, gensupport.WrapError(&googleapi.Error{ + Code: res.StatusCode, + Header: res.Header, + }) + } + if err != nil { + return nil, err + } + defer googleapi.CloseBody(res) + if err := googleapi.CheckResponse(res); err != nil { + return nil, gensupport.WrapError(err) + } + ret := &ListLfpProvidersResponse{ + ServerResponse: googleapi.ServerResponse{ + Header: res.Header, + HTTPStatusCode: res.StatusCode, + }, + } + target := &ret + if err := gensupport.DecodeResponse(target, res); err != nil { + return nil, err + } + return ret, nil +} + +// Pages invokes f for each page of results. +// A non-nil error returned from f will halt the iteration. +// The provided context supersedes any context provided to the Context method. +func (c *AccountsOmnichannelSettingsLfpProvidersListCall) Pages(ctx context.Context, f func(*ListLfpProvidersResponse) error) error { + c.ctx_ = ctx + defer c.PageToken(c.urlParams_.Get("pageToken")) + for { + x, err := c.Do() + if err != nil { + return err + } + if err := f(x); err != nil { + return err + } + if x.NextPageToken == "" { + return nil + } + c.PageToken(x.NextPageToken) + } +} + type AccountsOnlineReturnPoliciesGetCall struct { s *APIService name string diff --git a/merchantapi/datasources_v1beta/merchantapi-api.json b/merchantapi/datasources_v1beta/merchantapi-api.json index e0f459476bd..3443536a104 100644 --- a/merchantapi/datasources_v1beta/merchantapi-api.json +++ b/merchantapi/datasources_v1beta/merchantapi-api.json @@ -321,7 +321,7 @@ } } }, - "revision": "20241022", + "revision": "20241101", "rootUrl": "https://merchantapi.googleapis.com/", "schemas": { "DataSource": { @@ -779,7 +779,8 @@ "CLOUD_RETAIL", "LOCAL_CLOUD_RETAIL", "PRODUCT_REVIEWS", - "MERCHANT_REVIEWS" + "MERCHANT_REVIEWS", + "YOUTUBE_CHECKOUT" ], "enumDeprecated": [ false, @@ -798,6 +799,7 @@ false, false, false, + false, false ], "enumDescriptions": [ @@ -817,7 +819,8 @@ "[Cloud retail](https://cloud.google.com/solutions/retail).", "[Local cloud retail](https://cloud.google.com/solutions/retail).", "[Product Reviews](https://support.google.com/merchants/answer/14620732).", - "[Merchant Reviews](https://developers.google.com/merchant-review-feeds)." + "[Merchant Reviews](https://developers.google.com/merchant-review-feeds).", + "[YouTube Checkout](" ], "type": "string" } diff --git a/merchantapi/datasources_v1beta/merchantapi-gen.go b/merchantapi/datasources_v1beta/merchantapi-gen.go index d6a18df0939..d46dd3621cb 100644 --- a/merchantapi/datasources_v1beta/merchantapi-gen.go +++ b/merchantapi/datasources_v1beta/merchantapi-gen.go @@ -699,6 +699,7 @@ type ProductChange struct { // Reviews](https://support.google.com/merchants/answer/14620732). // "MERCHANT_REVIEWS" - [Merchant // Reviews](https://developers.google.com/merchant-review-feeds). + // "YOUTUBE_CHECKOUT" - [YouTube Checkout]( ReportingContext string `json:"reportingContext,omitempty"` // ForceSendFields is a list of field names (e.g. "NewValue") to // unconditionally include in API requests. By default, fields with empty or diff --git a/merchantapi/inventories_v1beta/merchantapi-api.json b/merchantapi/inventories_v1beta/merchantapi-api.json index cd21b293baa..2662904176c 100644 --- a/merchantapi/inventories_v1beta/merchantapi-api.json +++ b/merchantapi/inventories_v1beta/merchantapi-api.json @@ -300,7 +300,7 @@ } } }, - "revision": "20241022", + "revision": "20241101", "rootUrl": "https://merchantapi.googleapis.com/", "schemas": { "CustomAttribute": { @@ -497,7 +497,8 @@ "CLOUD_RETAIL", "LOCAL_CLOUD_RETAIL", "PRODUCT_REVIEWS", - "MERCHANT_REVIEWS" + "MERCHANT_REVIEWS", + "YOUTUBE_CHECKOUT" ], "enumDeprecated": [ false, @@ -516,6 +517,7 @@ false, false, false, + false, false ], "enumDescriptions": [ @@ -535,7 +537,8 @@ "[Cloud retail](https://cloud.google.com/solutions/retail).", "[Local cloud retail](https://cloud.google.com/solutions/retail).", "[Product Reviews](https://support.google.com/merchants/answer/14620732).", - "[Merchant Reviews](https://developers.google.com/merchant-review-feeds)." + "[Merchant Reviews](https://developers.google.com/merchant-review-feeds).", + "[YouTube Checkout](" ], "type": "string" } diff --git a/merchantapi/inventories_v1beta/merchantapi-gen.go b/merchantapi/inventories_v1beta/merchantapi-gen.go index f2a6fb9a1fc..d57711065a6 100644 --- a/merchantapi/inventories_v1beta/merchantapi-gen.go +++ b/merchantapi/inventories_v1beta/merchantapi-gen.go @@ -469,6 +469,7 @@ type ProductChange struct { // Reviews](https://support.google.com/merchants/answer/14620732). // "MERCHANT_REVIEWS" - [Merchant // Reviews](https://developers.google.com/merchant-review-feeds). + // "YOUTUBE_CHECKOUT" - [YouTube Checkout]( ReportingContext string `json:"reportingContext,omitempty"` // ForceSendFields is a list of field names (e.g. "NewValue") to // unconditionally include in API requests. By default, fields with empty or diff --git a/merchantapi/lfp_v1beta/merchantapi-api.json b/merchantapi/lfp_v1beta/merchantapi-api.json index b9129810e42..2a767fc4939 100644 --- a/merchantapi/lfp_v1beta/merchantapi-api.json +++ b/merchantapi/lfp_v1beta/merchantapi-api.json @@ -298,7 +298,7 @@ } } }, - "revision": "20241023", + "revision": "20241101", "rootUrl": "https://merchantapi.googleapis.com/", "schemas": { "Empty": { @@ -571,7 +571,8 @@ "CLOUD_RETAIL", "LOCAL_CLOUD_RETAIL", "PRODUCT_REVIEWS", - "MERCHANT_REVIEWS" + "MERCHANT_REVIEWS", + "YOUTUBE_CHECKOUT" ], "enumDeprecated": [ false, @@ -590,6 +591,7 @@ false, false, false, + false, false ], "enumDescriptions": [ @@ -609,7 +611,8 @@ "[Cloud retail](https://cloud.google.com/solutions/retail).", "[Local cloud retail](https://cloud.google.com/solutions/retail).", "[Product Reviews](https://support.google.com/merchants/answer/14620732).", - "[Merchant Reviews](https://developers.google.com/merchant-review-feeds)." + "[Merchant Reviews](https://developers.google.com/merchant-review-feeds).", + "[YouTube Checkout](" ], "type": "string" } diff --git a/merchantapi/lfp_v1beta/merchantapi-gen.go b/merchantapi/lfp_v1beta/merchantapi-gen.go index 4ddad419c0a..f35c9f85608 100644 --- a/merchantapi/lfp_v1beta/merchantapi-gen.go +++ b/merchantapi/lfp_v1beta/merchantapi-gen.go @@ -518,6 +518,7 @@ type ProductChange struct { // Reviews](https://support.google.com/merchants/answer/14620732). // "MERCHANT_REVIEWS" - [Merchant // Reviews](https://developers.google.com/merchant-review-feeds). + // "YOUTUBE_CHECKOUT" - [YouTube Checkout]( ReportingContext string `json:"reportingContext,omitempty"` // ForceSendFields is a list of field names (e.g. "NewValue") to // unconditionally include in API requests. By default, fields with empty or diff --git a/merchantapi/notifications_v1beta/merchantapi-api.json b/merchantapi/notifications_v1beta/merchantapi-api.json index c65ba55ab82..e186c989633 100644 --- a/merchantapi/notifications_v1beta/merchantapi-api.json +++ b/merchantapi/notifications_v1beta/merchantapi-api.json @@ -262,7 +262,7 @@ } } }, - "revision": "20241022", + "revision": "20241101", "rootUrl": "https://merchantapi.googleapis.com/", "schemas": { "Empty": { @@ -360,7 +360,8 @@ "CLOUD_RETAIL", "LOCAL_CLOUD_RETAIL", "PRODUCT_REVIEWS", - "MERCHANT_REVIEWS" + "MERCHANT_REVIEWS", + "YOUTUBE_CHECKOUT" ], "enumDeprecated": [ false, @@ -379,6 +380,7 @@ false, false, false, + false, false ], "enumDescriptions": [ @@ -398,7 +400,8 @@ "[Cloud retail](https://cloud.google.com/solutions/retail).", "[Local cloud retail](https://cloud.google.com/solutions/retail).", "[Product Reviews](https://support.google.com/merchants/answer/14620732).", - "[Merchant Reviews](https://developers.google.com/merchant-review-feeds)." + "[Merchant Reviews](https://developers.google.com/merchant-review-feeds).", + "[YouTube Checkout](" ], "type": "string" } diff --git a/merchantapi/notifications_v1beta/merchantapi-gen.go b/merchantapi/notifications_v1beta/merchantapi-gen.go index 6db190ecb92..6695e2cba5a 100644 --- a/merchantapi/notifications_v1beta/merchantapi-gen.go +++ b/merchantapi/notifications_v1beta/merchantapi-gen.go @@ -305,6 +305,7 @@ type ProductChange struct { // Reviews](https://support.google.com/merchants/answer/14620732). // "MERCHANT_REVIEWS" - [Merchant // Reviews](https://developers.google.com/merchant-review-feeds). + // "YOUTUBE_CHECKOUT" - [YouTube Checkout]( ReportingContext string `json:"reportingContext,omitempty"` // ForceSendFields is a list of field names (e.g. "NewValue") to // unconditionally include in API requests. By default, fields with empty or diff --git a/merchantapi/products_v1beta/merchantapi-api.json b/merchantapi/products_v1beta/merchantapi-api.json index cdff7dd0ecf..68b13f874aa 100644 --- a/merchantapi/products_v1beta/merchantapi-api.json +++ b/merchantapi/products_v1beta/merchantapi-api.json @@ -242,7 +242,7 @@ } } }, - "revision": "20241022", + "revision": "20241101", "rootUrl": "https://merchantapi.googleapis.com/", "schemas": { "Attributes": { @@ -826,7 +826,8 @@ "CLOUD_RETAIL", "LOCAL_CLOUD_RETAIL", "PRODUCT_REVIEWS", - "MERCHANT_REVIEWS" + "MERCHANT_REVIEWS", + "YOUTUBE_CHECKOUT" ], "enumDeprecated": [ false, @@ -845,6 +846,7 @@ false, false, false, + false, false ], "enumDescriptions": [ @@ -864,7 +866,8 @@ "[Cloud retail](https://cloud.google.com/solutions/retail).", "[Local cloud retail](https://cloud.google.com/solutions/retail).", "[Product Reviews](https://support.google.com/merchants/answer/14620732).", - "[Merchant Reviews](https://developers.google.com/merchant-review-feeds)." + "[Merchant Reviews](https://developers.google.com/merchant-review-feeds).", + "[YouTube Checkout](" ], "type": "string" } @@ -983,7 +986,8 @@ "CLOUD_RETAIL", "LOCAL_CLOUD_RETAIL", "PRODUCT_REVIEWS", - "MERCHANT_REVIEWS" + "MERCHANT_REVIEWS", + "YOUTUBE_CHECKOUT" ], "enumDeprecated": [ false, @@ -1002,6 +1006,7 @@ false, false, false, + false, false ], "enumDescriptions": [ @@ -1021,7 +1026,8 @@ "[Cloud retail](https://cloud.google.com/solutions/retail).", "[Local cloud retail](https://cloud.google.com/solutions/retail).", "[Product Reviews](https://support.google.com/merchants/answer/14620732).", - "[Merchant Reviews](https://developers.google.com/merchant-review-feeds)." + "[Merchant Reviews](https://developers.google.com/merchant-review-feeds).", + "[YouTube Checkout](" ], "type": "string" }, @@ -1240,7 +1246,8 @@ "CLOUD_RETAIL", "LOCAL_CLOUD_RETAIL", "PRODUCT_REVIEWS", - "MERCHANT_REVIEWS" + "MERCHANT_REVIEWS", + "YOUTUBE_CHECKOUT" ], "enumDeprecated": [ false, @@ -1259,6 +1266,7 @@ false, false, false, + false, false ], "enumDescriptions": [ @@ -1278,7 +1286,8 @@ "[Cloud retail](https://cloud.google.com/solutions/retail).", "[Local cloud retail](https://cloud.google.com/solutions/retail).", "[Product Reviews](https://support.google.com/merchants/answer/14620732).", - "[Merchant Reviews](https://developers.google.com/merchant-review-feeds)." + "[Merchant Reviews](https://developers.google.com/merchant-review-feeds).", + "[YouTube Checkout](" ], "type": "string" } diff --git a/merchantapi/products_v1beta/merchantapi-gen.go b/merchantapi/products_v1beta/merchantapi-gen.go index c04ae149cf0..84e21434748 100644 --- a/merchantapi/products_v1beta/merchantapi-gen.go +++ b/merchantapi/products_v1beta/merchantapi-gen.go @@ -665,6 +665,7 @@ type DestinationStatus struct { // Reviews](https://support.google.com/merchants/answer/14620732). // "MERCHANT_REVIEWS" - [Merchant // Reviews](https://developers.google.com/merchant-review-feeds). + // "YOUTUBE_CHECKOUT" - [YouTube Checkout]( ReportingContext string `json:"reportingContext,omitempty"` // ForceSendFields is a list of field names (e.g. "ApprovedCountries") to // unconditionally include in API requests. By default, fields with empty or @@ -833,6 +834,7 @@ type ItemLevelIssue struct { // Reviews](https://support.google.com/merchants/answer/14620732). // "MERCHANT_REVIEWS" - [Merchant // Reviews](https://developers.google.com/merchant-review-feeds). + // "YOUTUBE_CHECKOUT" - [YouTube Checkout]( ReportingContext string `json:"reportingContext,omitempty"` // Resolution: Whether the issue can be resolved by the merchant. Resolution string `json:"resolution,omitempty"` @@ -1129,6 +1131,7 @@ type ProductChange struct { // Reviews](https://support.google.com/merchants/answer/14620732). // "MERCHANT_REVIEWS" - [Merchant // Reviews](https://developers.google.com/merchant-review-feeds). + // "YOUTUBE_CHECKOUT" - [YouTube Checkout]( ReportingContext string `json:"reportingContext,omitempty"` // ForceSendFields is a list of field names (e.g. "NewValue") to // unconditionally include in API requests. By default, fields with empty or diff --git a/merchantapi/promotions_v1beta/merchantapi-api.json b/merchantapi/promotions_v1beta/merchantapi-api.json index 487aaca2c01..fe95f6dc0ab 100644 --- a/merchantapi/promotions_v1beta/merchantapi-api.json +++ b/merchantapi/promotions_v1beta/merchantapi-api.json @@ -203,7 +203,7 @@ } } }, - "revision": "20241022", + "revision": "20241101", "rootUrl": "https://merchantapi.googleapis.com/", "schemas": { "Attributes": { @@ -505,7 +505,8 @@ "CLOUD_RETAIL", "LOCAL_CLOUD_RETAIL", "PRODUCT_REVIEWS", - "MERCHANT_REVIEWS" + "MERCHANT_REVIEWS", + "YOUTUBE_CHECKOUT" ], "enumDeprecated": [ false, @@ -524,6 +525,7 @@ false, false, false, + false, false ], "enumDescriptions": [ @@ -543,7 +545,8 @@ "[Cloud retail](https://cloud.google.com/solutions/retail).", "[Local cloud retail](https://cloud.google.com/solutions/retail).", "[Product Reviews](https://support.google.com/merchants/answer/14620732).", - "[Merchant Reviews](https://developers.google.com/merchant-review-feeds)." + "[Merchant Reviews](https://developers.google.com/merchant-review-feeds).", + "[YouTube Checkout](" ], "readOnly": true, "type": "string" @@ -662,7 +665,8 @@ "CLOUD_RETAIL", "LOCAL_CLOUD_RETAIL", "PRODUCT_REVIEWS", - "MERCHANT_REVIEWS" + "MERCHANT_REVIEWS", + "YOUTUBE_CHECKOUT" ], "enumDeprecated": [ false, @@ -681,6 +685,7 @@ false, false, false, + false, false ], "enumDescriptions": [ @@ -700,7 +705,8 @@ "[Cloud retail](https://cloud.google.com/solutions/retail).", "[Local cloud retail](https://cloud.google.com/solutions/retail).", "[Product Reviews](https://support.google.com/merchants/answer/14620732).", - "[Merchant Reviews](https://developers.google.com/merchant-review-feeds)." + "[Merchant Reviews](https://developers.google.com/merchant-review-feeds).", + "[YouTube Checkout](" ], "readOnly": true, "type": "string" @@ -799,7 +805,8 @@ "CLOUD_RETAIL", "LOCAL_CLOUD_RETAIL", "PRODUCT_REVIEWS", - "MERCHANT_REVIEWS" + "MERCHANT_REVIEWS", + "YOUTUBE_CHECKOUT" ], "enumDeprecated": [ false, @@ -818,6 +825,7 @@ false, false, false, + false, false ], "enumDescriptions": [ @@ -837,7 +845,8 @@ "[Cloud retail](https://cloud.google.com/solutions/retail).", "[Local cloud retail](https://cloud.google.com/solutions/retail).", "[Product Reviews](https://support.google.com/merchants/answer/14620732).", - "[Merchant Reviews](https://developers.google.com/merchant-review-feeds)." + "[Merchant Reviews](https://developers.google.com/merchant-review-feeds).", + "[YouTube Checkout](" ], "type": "string" } diff --git a/merchantapi/promotions_v1beta/merchantapi-gen.go b/merchantapi/promotions_v1beta/merchantapi-gen.go index bf1c45d7848..0c998564182 100644 --- a/merchantapi/promotions_v1beta/merchantapi-gen.go +++ b/merchantapi/promotions_v1beta/merchantapi-gen.go @@ -489,6 +489,7 @@ type DestinationStatus struct { // Reviews](https://support.google.com/merchants/answer/14620732). // "MERCHANT_REVIEWS" - [Merchant // Reviews](https://developers.google.com/merchant-review-feeds). + // "YOUTUBE_CHECKOUT" - [YouTube Checkout]( ReportingContext string `json:"reportingContext,omitempty"` // Status: Output only. The status for the specified destination. // @@ -630,6 +631,7 @@ type ItemLevelIssue struct { // Reviews](https://support.google.com/merchants/answer/14620732). // "MERCHANT_REVIEWS" - [Merchant // Reviews](https://developers.google.com/merchant-review-feeds). + // "YOUTUBE_CHECKOUT" - [YouTube Checkout]( ReportingContext string `json:"reportingContext,omitempty"` // Resolution: Output only. Whether the issue can be resolved by the merchant. Resolution string `json:"resolution,omitempty"` @@ -761,6 +763,7 @@ type ProductChange struct { // Reviews](https://support.google.com/merchants/answer/14620732). // "MERCHANT_REVIEWS" - [Merchant // Reviews](https://developers.google.com/merchant-review-feeds). + // "YOUTUBE_CHECKOUT" - [YouTube Checkout]( ReportingContext string `json:"reportingContext,omitempty"` // ForceSendFields is a list of field names (e.g. "NewValue") to // unconditionally include in API requests. By default, fields with empty or diff --git a/merchantapi/quota_v1beta/merchantapi-api.json b/merchantapi/quota_v1beta/merchantapi-api.json index f316bf3a961..6412659bc3b 100644 --- a/merchantapi/quota_v1beta/merchantapi-api.json +++ b/merchantapi/quota_v1beta/merchantapi-api.json @@ -150,7 +150,7 @@ } } }, - "revision": "20241022", + "revision": "20241101", "rootUrl": "https://merchantapi.googleapis.com/", "schemas": { "ListQuotaGroupsResponse": { @@ -233,7 +233,8 @@ "CLOUD_RETAIL", "LOCAL_CLOUD_RETAIL", "PRODUCT_REVIEWS", - "MERCHANT_REVIEWS" + "MERCHANT_REVIEWS", + "YOUTUBE_CHECKOUT" ], "enumDeprecated": [ false, @@ -252,6 +253,7 @@ false, false, false, + false, false ], "enumDescriptions": [ @@ -271,7 +273,8 @@ "[Cloud retail](https://cloud.google.com/solutions/retail).", "[Local cloud retail](https://cloud.google.com/solutions/retail).", "[Product Reviews](https://support.google.com/merchants/answer/14620732).", - "[Merchant Reviews](https://developers.google.com/merchant-review-feeds)." + "[Merchant Reviews](https://developers.google.com/merchant-review-feeds).", + "[YouTube Checkout](" ], "type": "string" } diff --git a/merchantapi/quota_v1beta/merchantapi-gen.go b/merchantapi/quota_v1beta/merchantapi-gen.go index 1d9650b678f..e35c2a1bd43 100644 --- a/merchantapi/quota_v1beta/merchantapi-gen.go +++ b/merchantapi/quota_v1beta/merchantapi-gen.go @@ -278,6 +278,7 @@ type ProductChange struct { // Reviews](https://support.google.com/merchants/answer/14620732). // "MERCHANT_REVIEWS" - [Merchant // Reviews](https://developers.google.com/merchant-review-feeds). + // "YOUTUBE_CHECKOUT" - [YouTube Checkout]( ReportingContext string `json:"reportingContext,omitempty"` // ForceSendFields is a list of field names (e.g. "NewValue") to // unconditionally include in API requests. By default, fields with empty or diff --git a/playdeveloperreporting/v1alpha1/playdeveloperreporting-api.json b/playdeveloperreporting/v1alpha1/playdeveloperreporting-api.json index aaef069b42e..842012f6a61 100644 --- a/playdeveloperreporting/v1alpha1/playdeveloperreporting-api.json +++ b/playdeveloperreporting/v1alpha1/playdeveloperreporting-api.json @@ -947,7 +947,7 @@ } } }, - "revision": "20241009", + "revision": "20241102", "rootUrl": "https://playdeveloperreporting.googleapis.com/", "schemas": { "GooglePlayDeveloperReportingV1alpha1Anomaly": { @@ -2164,7 +2164,7 @@ "type": "object" }, "GoogleTypeDecimal": { - "description": "A representation of a decimal value, such as 2.5. Clients may convert values into language-native decimal formats, such as Java's BigDecimal or Python's decimal.Decimal. [BigDecimal]: https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/math/BigDecimal.html [decimal.Decimal]: https://docs.python.org/3/library/decimal.html", + "description": "A representation of a decimal value, such as 2.5. Clients may convert values into language-native decimal formats, such as Java's [BigDecimal](https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/math/BigDecimal.html) or Python's [decimal.Decimal](https://docs.python.org/3/library/decimal.html).", "id": "GoogleTypeDecimal", "properties": { "value": { diff --git a/playdeveloperreporting/v1alpha1/playdeveloperreporting-gen.go b/playdeveloperreporting/v1alpha1/playdeveloperreporting-gen.go index 62b91295298..3f681d07889 100644 --- a/playdeveloperreporting/v1alpha1/playdeveloperreporting-gen.go +++ b/playdeveloperreporting/v1alpha1/playdeveloperreporting-gen.go @@ -2682,9 +2682,10 @@ func (s GoogleTypeDateTime) MarshalJSON() ([]byte, error) { // GoogleTypeDecimal: A representation of a decimal value, such as 2.5. Clients // may convert values into language-native decimal formats, such as Java's -// BigDecimal or Python's decimal.Decimal. [BigDecimal]: -// https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/math/BigDecimal.html -// [decimal.Decimal]: https://docs.python.org/3/library/decimal.html +// BigDecimal +// (https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/math/BigDecimal.html) +// or Python's decimal.Decimal +// (https://docs.python.org/3/library/decimal.html). type GoogleTypeDecimal struct { // Value: The decimal value, as a string. The string representation consists of // an optional sign, `+` (`U+002B`) or `-` (`U+002D`), followed by a sequence diff --git a/playdeveloperreporting/v1beta1/playdeveloperreporting-api.json b/playdeveloperreporting/v1beta1/playdeveloperreporting-api.json index 36b7bcc1527..da952d3cf19 100644 --- a/playdeveloperreporting/v1beta1/playdeveloperreporting-api.json +++ b/playdeveloperreporting/v1beta1/playdeveloperreporting-api.json @@ -947,7 +947,7 @@ } } }, - "revision": "20241009", + "revision": "20241102", "rootUrl": "https://playdeveloperreporting.googleapis.com/", "schemas": { "GooglePlayDeveloperReportingV1beta1Anomaly": { @@ -2164,7 +2164,7 @@ "type": "object" }, "GoogleTypeDecimal": { - "description": "A representation of a decimal value, such as 2.5. Clients may convert values into language-native decimal formats, such as Java's BigDecimal or Python's decimal.Decimal. [BigDecimal]: https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/math/BigDecimal.html [decimal.Decimal]: https://docs.python.org/3/library/decimal.html", + "description": "A representation of a decimal value, such as 2.5. Clients may convert values into language-native decimal formats, such as Java's [BigDecimal](https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/math/BigDecimal.html) or Python's [decimal.Decimal](https://docs.python.org/3/library/decimal.html).", "id": "GoogleTypeDecimal", "properties": { "value": { diff --git a/playdeveloperreporting/v1beta1/playdeveloperreporting-gen.go b/playdeveloperreporting/v1beta1/playdeveloperreporting-gen.go index 1ed3c1e1357..daf3e50d659 100644 --- a/playdeveloperreporting/v1beta1/playdeveloperreporting-gen.go +++ b/playdeveloperreporting/v1beta1/playdeveloperreporting-gen.go @@ -2682,9 +2682,10 @@ func (s GoogleTypeDateTime) MarshalJSON() ([]byte, error) { // GoogleTypeDecimal: A representation of a decimal value, such as 2.5. Clients // may convert values into language-native decimal formats, such as Java's -// BigDecimal or Python's decimal.Decimal. [BigDecimal]: -// https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/math/BigDecimal.html -// [decimal.Decimal]: https://docs.python.org/3/library/decimal.html +// BigDecimal +// (https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/math/BigDecimal.html) +// or Python's decimal.Decimal +// (https://docs.python.org/3/library/decimal.html). type GoogleTypeDecimal struct { // Value: The decimal value, as a string. The string representation consists of // an optional sign, `+` (`U+002B`) or `-` (`U+002D`), followed by a sequence diff --git a/servicenetworking/v1/servicenetworking-api.json b/servicenetworking/v1/servicenetworking-api.json index 88feacde98f..35d679b8fc2 100644 --- a/servicenetworking/v1/servicenetworking-api.json +++ b/servicenetworking/v1/servicenetworking-api.json @@ -1029,7 +1029,7 @@ } } }, - "revision": "20240925", + "revision": "20241103", "rootUrl": "https://servicenetworking.googleapis.com/", "schemas": { "AddDnsRecordSetMetadata": { @@ -3419,7 +3419,7 @@ "type": "string" }, "unit": { - "description": "Specify the unit of the quota limit. It uses the same syntax as Metric.unit. The supported unit kinds are determined by the quota backend system. Here are some examples: * \"1/min/{project}\" for quota per minute per project. Note: the order of unit components is insignificant. The \"1\" at the beginning is required to follow the metric unit syntax.", + "description": "Specify the unit of the quota limit. It uses the same syntax as MetricDescriptor.unit. The supported unit kinds are determined by the quota backend system. Here are some examples: * \"1/min/{project}\" for quota per minute per project. Note: the order of unit components is insignificant. The \"1\" at the beginning is required to follow the metric unit syntax.", "type": "string" }, "values": { diff --git a/servicenetworking/v1/servicenetworking-gen.go b/servicenetworking/v1/servicenetworking-gen.go index 3a7474063a0..0af44d6b730 100644 --- a/servicenetworking/v1/servicenetworking-gen.go +++ b/servicenetworking/v1/servicenetworking-gen.go @@ -3917,10 +3917,10 @@ type QuotaLimit struct { // as well as '-'. The maximum length of the limit name is 64 characters. Name string `json:"name,omitempty"` // Unit: Specify the unit of the quota limit. It uses the same syntax as - // Metric.unit. The supported unit kinds are determined by the quota backend - // system. Here are some examples: * "1/min/{project}" for quota per minute per - // project. Note: the order of unit components is insignificant. The "1" at the - // beginning is required to follow the metric unit syntax. + // MetricDescriptor.unit. The supported unit kinds are determined by the quota + // backend system. Here are some examples: * "1/min/{project}" for quota per + // minute per project. Note: the order of unit components is insignificant. The + // "1" at the beginning is required to follow the metric unit syntax. Unit string `json:"unit,omitempty"` // Values: Tiered limit values. You must specify this as a key:value pair, with // an integer value that is the maximum number of requests allowed for the diff --git a/servicenetworking/v1beta/servicenetworking-api.json b/servicenetworking/v1beta/servicenetworking-api.json index ca7d79162da..87f1982b684 100644 --- a/servicenetworking/v1beta/servicenetworking-api.json +++ b/servicenetworking/v1beta/servicenetworking-api.json @@ -307,7 +307,7 @@ } } }, - "revision": "20240925", + "revision": "20241103", "rootUrl": "https://servicenetworking.googleapis.com/", "schemas": { "AddDnsRecordSetMetadata": { @@ -2439,7 +2439,7 @@ "type": "string" }, "unit": { - "description": "Specify the unit of the quota limit. It uses the same syntax as Metric.unit. The supported unit kinds are determined by the quota backend system. Here are some examples: * \"1/min/{project}\" for quota per minute per project. Note: the order of unit components is insignificant. The \"1\" at the beginning is required to follow the metric unit syntax.", + "description": "Specify the unit of the quota limit. It uses the same syntax as MetricDescriptor.unit. The supported unit kinds are determined by the quota backend system. Here are some examples: * \"1/min/{project}\" for quota per minute per project. Note: the order of unit components is insignificant. The \"1\" at the beginning is required to follow the metric unit syntax.", "type": "string" }, "values": { diff --git a/servicenetworking/v1beta/servicenetworking-gen.go b/servicenetworking/v1beta/servicenetworking-gen.go index 90f42c20dbd..668142d12b3 100644 --- a/servicenetworking/v1beta/servicenetworking-gen.go +++ b/servicenetworking/v1beta/servicenetworking-gen.go @@ -3369,10 +3369,10 @@ type QuotaLimit struct { // as well as '-'. The maximum length of the limit name is 64 characters. Name string `json:"name,omitempty"` // Unit: Specify the unit of the quota limit. It uses the same syntax as - // Metric.unit. The supported unit kinds are determined by the quota backend - // system. Here are some examples: * "1/min/{project}" for quota per minute per - // project. Note: the order of unit components is insignificant. The "1" at the - // beginning is required to follow the metric unit syntax. + // MetricDescriptor.unit. The supported unit kinds are determined by the quota + // backend system. Here are some examples: * "1/min/{project}" for quota per + // minute per project. Note: the order of unit components is insignificant. The + // "1" at the beginning is required to follow the metric unit syntax. Unit string `json:"unit,omitempty"` // Values: Tiered limit values. You must specify this as a key:value pair, with // an integer value that is the maximum number of requests allowed for the