@google-cloud/retail

{ "nested": { "google": { "nested": { "cloud": { "nested": { "retail": { "nested": { "v2": { "options": { "csharp_namespace": "Google.Cloud.Retail.V2", "go_package": "cloud.google.com/go/retail/apiv2/retailpb;retailpb", "java_multiple_files": true, "java_outer_classname": "UserEventServiceProto", "java_package": "com.google.cloud.retail.v2", "objc_class_prefix": "RETAIL", "php_namespace": "Google\\Cloud\\Retail\\V2", "ruby_package": "Google::Cloud::Retail::V2", "(google.api.resource_definition).type": "retail.googleapis.com/Experiment", "(google.api.resource_definition).pattern": "projects/{project}/locations/{location}/catalogs/{catalog}/experiments/{experiment}" }, "nested": { "AnalyticsService": { "options": { "(google.api.default_host)": "retail.googleapis.com", "(google.api.oauth_scopes)": "https://www.googleapis.com/auth/cloud-platform" }, "methods": { "ExportAnalyticsMetrics": { "requestType": "ExportAnalyticsMetricsRequest", "responseType": "google.longrunning.Operation", "options": { "(google.api.http).post": "/v2/{catalog=projects/*/locations/*/catalogs/*}:exportAnalyticsMetrics", "(google.api.http).body": "*", "(google.longrunning.operation_info).response_type": "google.cloud.retail.v2.ExportAnalyticsMetricsResponse", "(google.longrunning.operation_info).metadata_type": "google.cloud.retail.v2.ExportMetadata" }, "parsedOptions": [ { "(google.api.http)": { "post": "/v2/{catalog=projects/*/locations/*/catalogs/*}:exportAnalyticsMetrics", "body": "*" } }, { "(google.longrunning.operation_info)": { "response_type": "google.cloud.retail.v2.ExportAnalyticsMetricsResponse", "metadata_type": "google.cloud.retail.v2.ExportMetadata" } } ] } } }, "OutputConfig": { "oneofs": { "destination": { "oneof": [ "gcsDestination", "bigqueryDestination" ] } }, "fields": { "gcsDestination": { "type": "GcsDestination", "id": 1 }, "bigqueryDestination": { "type": "BigQueryDestination", "id": 2 } }, "nested": { "GcsDestination": { "fields": { "outputUriPrefix": { "type": "string", "id": 1, "options": { "(google.api.field_behavior)": "REQUIRED" } } } }, "BigQueryDestination": { "fields": { "datasetId": { "type": "string", "id": 1, "options": { "(google.api.field_behavior)": "REQUIRED" } }, "tableIdPrefix": { "type": "string", "id": 2, "options": { "(google.api.field_behavior)": "REQUIRED" } }, "tableType": { "type": "string", "id": 3, "options": { "(google.api.field_behavior)": "REQUIRED" } } } } } }, "ExportErrorsConfig": { "oneofs": { "destination": { "oneof": [ "gcsPrefix" ] } }, "fields": { "gcsPrefix": { "type": "string", "id": 1 } } }, "ExportAnalyticsMetricsRequest": { "fields": { "catalog": { "type": "string", "id": 1, "options": { "(google.api.field_behavior)": "REQUIRED" } }, "outputConfig": { "type": "OutputConfig", "id": 2, "options": { "(google.api.field_behavior)": "REQUIRED" } }, "filter": { "type": "string", "id": 3 } } }, "ExportMetadata": { "fields": { "createTime": { "type": "google.protobuf.Timestamp", "id": 1 }, "updateTime": { "type": "google.protobuf.Timestamp", "id": 2 } } }, "ExportAnalyticsMetricsResponse": { "fields": { "errorSamples": { "rule": "repeated", "type": "google.rpc.Status", "id": 1 }, "errorsConfig": { "type": "ExportErrorsConfig", "id": 2 }, "outputResult": { "type": "OutputResult", "id": 3 } } }, "OutputResult": { "fields": { "bigqueryResult": { "rule": "repeated", "type": "BigQueryOutputResult", "id": 1 }, "gcsResult": { "rule": "repeated", "type": "GcsOutputResult", "id": 2 } } }, "BigQueryOutputResult": { "fields": { "datasetId": { "type": "string", "id": 1 }, "tableId": { "type": "string", "id": 2 } } }, "GcsOutputResult": { "fields": { "outputUri": { "type": "string", "id": 1 } } }, "ProductLevelConfig": { "fields": { "ingestionProductType": { "type": "string", "id": 1 }, "merchantCenterProductIdField": { "type": "string", "id": 2 } } }, "CatalogAttribute": { "fields": { "key": { "type": "string", "id": 1, "options": { "(google.api.field_behavior)": "REQUIRED" } }, "inUse": { "type": "bool", "id": 9, "options": { "(google.api.field_behavior)": "OUTPUT_ONLY" } }, "type": { "type": "AttributeType", "id": 10, "options": { "(google.api.field_behavior)": "OUTPUT_ONLY" } }, "indexableOption": { "type": "IndexableOption", "id": 5 }, "dynamicFacetableOption": { "type": "DynamicFacetableOption", "id": 6 }, "searchableOption": { "type": "SearchableOption", "id": 7 }, "exactSearchableOption": { "type": "ExactSearchableOption", "id": 11 }, "retrievableOption": { "type": "RetrievableOption", "id": 12 }, "facetConfig": { "type": "FacetConfig", "id": 13 } }, "nested": { "FacetConfig": { "fields": { "facetIntervals": { "rule": "repeated", "type": "Interval", "id": 1 }, "ignoredFacetValues": { "rule": "repeated", "type": "IgnoredFacetValues", "id": 2 }, "mergedFacetValues": { "rule": "repeated", "type": "MergedFacetValue", "id": 3 }, "mergedFacet": { "type": "MergedFacet", "id": 4 }, "rerankConfig": { "type": "RerankConfig", "id": 5 } }, "nested": { "IgnoredFacetValues": { "fields": { "values": { "rule": "repeated", "type": "string", "id": 1 }, "startTime": { "type": "google.protobuf.Timestamp", "id": 2 }, "endTime": { "type": "google.protobuf.Timestamp", "id": 3 } } }, "MergedFacetValue": { "fields": { "values": { "rule": "repeated", "type": "string", "id": 1 }, "mergedValue": { "type": "string", "id": 2 } } }, "MergedFacet": { "fields": { "mergedFacetKey": { "type": "string", "id": 1 } } }, "RerankConfig": { "fields": { "rerankFacet": { "type": "bool", "id": 1 }, "facetValues": { "rule": "repeated", "type": "string", "id": 2 } } } } }, "AttributeType": { "values": { "UNKNOWN": 0, "TEXTUAL": 1, "NUMERICAL": 2 } }, "IndexableOption": { "values": { "INDEXABLE_OPTION_UNSPECIFIED": 0, "INDEXABLE_ENABLED": 1, "INDEXABLE_DISABLED": 2 } }, "DynamicFacetableOption": { "values": { "DYNAMIC_FACETABLE_OPTION_UNSPECIFIED": 0, "DYNAMIC_FACETABLE_ENABLED": 1, "DYNAMIC_FACETABLE_DISABLED": 2 } }, "SearchableOption": { "values": { "SEARCHABLE_OPTION_UNSPECIFIED": 0, "SEARCHABLE_ENABLED": 1, "SEARCHABLE_DISABLED": 2 } }, "ExactSearchableOption": { "values": { "EXACT_SEARCHABLE_OPTION_UNSPECIFIED": 0, "EXACT_SEARCHABLE_ENABLED": 1, "EXACT_SEARCHABLE_DISABLED": 2 } }, "RetrievableOption": { "values": { "RETRIEVABLE_OPTION_UNSPECIFIED": 0, "RETRIEVABLE_ENABLED": 1, "RETRIEVABLE_DISABLED": 2 } } } }, "AttributesConfig": { "options": { "(google.api.resource).type": "retail.googleapis.com/AttributesConfig", "(google.api.resource).pattern": "projects/{project}/locations/{location}/catalogs/{catalog}/attributesConfig" }, "fields": { "name": { "type": "string", "id": 1, "options": { "(google.api.field_behavior)": "IMMUTABLE" } }, "catalogAttributes": { "keyType": "string", "type": "CatalogAttribute", "id": 2 }, "attributeConfigLevel": { "type": "AttributeConfigLevel", "id": 3, "options": { "(google.api.field_behavior)": "OUTPUT_ONLY" } } } }, "CompletionConfig": { "options": { "(google.api.resource).type": "retail.googleapis.com/CompletionConfig", "(google.api.resource).pattern": "projects/{project}/locations/{location}/catalogs/{catalog}/completionConfig" }, "fields": { "name": { "type": "string", "id": 1, "options": { "(google.api.field_behavior)": "IMMUTABLE" } }, "matchingOrder": { "type": "string", "id": 2 }, "maxSuggestions": { "type": "int32", "id": 3 }, "minPrefixLength": { "type": "int32", "id": 4 }, "autoLearning": { "type": "bool", "id": 11 }, "suggestionsInputConfig": { "type": "CompletionDataInputConfig", "id": 5, "options": { "(google.api.field_behavior)": "OUTPUT_ONLY" } }, "lastSuggestionsImportOperation": { "type": "string", "id": 6, "options": { "(google.api.field_behavior)": "OUTPUT_ONLY" } }, "denylistInputConfig": { "type": "CompletionDataInputConfig", "id": 7, "options": { "(google.api.field_behavior)": "OUTPUT_ONLY" } }, "lastDenylistImportOperation": { "type": "string", "id": 8, "options": { "(google.api.field_behavior)": "OUTPUT_ONLY" } }, "allowlistInputConfig": { "type": "CompletionDataInputConfig", "id": 9, "options": { "(google.api.field_behavior)": "OUTPUT_ONLY" } }, "lastAllowlistImportOperation": { "type": "string", "id": 10, "options": { "(google.api.field_behavior)": "OUTPUT_ONLY" } } } }, "Catalog": { "options": { "(google.api.resource).type": "retail.googleapis.com/Catalog", "(google.api.resource).pattern": "projects/{project}/locations/{location}/catalogs/{catalog}" }, "fields": { "name": { "type": "string", "id": 1, "options": { "(google.api.field_behavior)": "IMMUTABLE" } }, "displayName": { "type": "string", "id": 2, "options": { "(google.api.field_behavior)": "IMMUTABLE" } }, "productLevelConfig": { "type": "ProductLevelConfig", "id": 4, "options": { "(google.api.field_behavior)": "REQUIRED" } } } }, "AttributeConfigLevel": { "values": { "ATTRIBUTE_CONFIG_LEVEL_UNSPECIFIED": 0, "PRODUCT_LEVEL_ATTRIBUTE_CONFIG": 1, "CATALOG_LEVEL_ATTRIBUTE_CONFIG": 2 } }, "SolutionType": { "values": { "SOLUTION_TYPE_UNSPECIFIED": 0, "SOLUTION_TYPE_RECOMMENDATION": 1, "SOLUTION_TYPE_SEARCH": 2 } }, "RecommendationsFilteringOption": { "values": { "RECOMMENDATIONS_FILTERING_OPTION_UNSPECIFIED": 0, "RECOMMENDATIONS_FILTERING_DISABLED": 1, "RECOMMENDATIONS_FILTERING_ENABLED": 3 } }, "SearchSolutionUseCase": { "values": { "SEARCH_SOLUTION_USE_CASE_UNSPECIFIED": 0, "SEARCH_SOLUTION_USE_CASE_SEARCH": 1, "SEARCH_SOLUTION_USE_CASE_BROWSE": 2 } }, "Condition": { "fields": { "queryTerms": { "rule": "repeated", "type": "QueryTerm", "id": 1 }, "activeTimeRange": { "rule": "repeated", "type": "TimeRange", "id": 3 }, "pageCategories": { "rule": "repeated", "type": "string", "id": 4 } }, "nested": { "QueryTerm": { "fields": { "value": { "type": "string", "id": 1 }, "fullMatch": { "type": "bool", "id": 2 } } }, "TimeRange": { "fields": { "startTime": { "type": "google.protobuf.Timestamp", "id": 1 }, "endTime": { "type": "google.protobuf.Timestamp", "id": 2 } } } } }, "Rule": { "oneofs": { "action": { "oneof": [ "boostAction", "redirectAction", "onewaySynonymsAction", "doNotAssociateAction", "replacementAction", "ignoreAction", "filterAction", "twowaySynonymsAction", "forceReturnFacetAction", "removeFacetAction", "pinAction" ] } }, "fields": { "boostAction": { "type": "BoostAction", "id": 2 }, "redirectAction": { "type": "RedirectAction", "id": 3 }, "onewaySynonymsAction": { "type": "OnewaySynonymsAction", "id": 6 }, "doNotAssociateAction": { "type": "DoNotAssociateAction", "id": 7 }, "replacementAction": { "type": "ReplacementAction", "id": 8 }, "ignoreAction": { "type": "IgnoreAction", "id": 9 }, "filterAction": { "type": "FilterAction", "id": 10 }, "twowaySynonymsAction": { "type": "TwowaySynonymsAction", "id": 11 }, "forceReturnFacetAction": { "type": "ForceReturnFacetAction", "id": 12 }, "removeFacetAction": { "type": "RemoveFacetAction", "id": 13 }, "pinAction": { "type": "PinAction", "id": 14 }, "condition": { "type": "Condition", "id": 1, "options": { "(google.api.field_behavior)": "REQUIRED" } } }, "nested": { "BoostAction": { "fields": { "boost": { "type": "float", "id": 1 }, "productsFilter": { "type": "string", "id": 2 } } }, "FilterAction": { "fields": { "filter": { "type": "string", "id": 1 } } }, "RedirectAction": { "fields": { "redirectUri": { "type": "string", "id": 1 } } }, "TwowaySynonymsAction": { "fields": { "synonyms": { "rule": "repeated", "type": "string", "id": 1 } } }, "OnewaySynonymsAction": { "fields": { "queryTerms": { "rule": "repeated", "type": "string", "id": 3 }, "synonyms": { "rule": "repeated", "type": "string", "id": 4 }, "onewayTerms": { "rule": "repeated", "type": "string", "id": 2 } } }, "DoNotAssociateAction": { "fields": { "queryTerms": { "rule": "repeated", "type": "string", "id": 2 }, "doNotAssociateTerms": { "rule": "repeated", "type": "string", "id": 3 }, "terms": { "rule": "repeated", "type": "string", "id": 1 } } }, "ReplacementAction": { "fields": { "queryTerms": { "rule": "repeated", "type": "string", "id": 2 }, "replacementTerm": { "type": "string", "id": 3 }, "term": { "type": "string", "id": 1 } } }, "IgnoreAction": { "fields": { "ignoreTerms": { "rule": "repeated", "type": "string", "id": 1 } } }, "ForceReturnFacetAction": { "fields": { "facetPositionAdjustments": { "rule": "repeated", "type": "FacetPositionAdjustment", "id": 1 } }, "nested": { "FacetPositionAdjustment": { "fields": { "attributeName": { "type": "string", "id": 1 }, "position": { "type": "int32", "id": 2 } } } } }, "RemoveFacetAction": { "fields": { "attributeNames": { "rule": "repeated", "type": "string", "id": 1 } } }, "PinAction": { "fields": { "pinMap": { "keyType": "int64", "type": "string", "id": 1, "options": { "(google.api.field_behavior)": "REQUIRED" } } } } } }, "Audience": { "fields": { "genders": { "rule": "repeated", "type": "string", "id": 1 }, "ageGroups": { "rule": "repeated", "type": "string", "id": 2 } } }, "ColorInfo": { "fields": { "colorFamilies": { "rule": "repeated", "type": "string", "id": 1 }, "colors": { "rule": "repeated", "type": "string", "id": 2 } } }, "CustomAttribute": { "oneofs": { "_searchable": { "oneof": [ "searchable" ] }, "_indexable": { "oneof": [ "indexable" ] } }, "fields": { "text": { "rule": "repeated", "type": "string", "id": 1 }, "numbers": { "rule": "repeated", "type": "double", "id": 2 }, "searchable": { "type": "bool", "id": 3, "options": { "deprecated": true, "proto3_optional": true } }, "indexable": { "type": "bool", "id": 4, "options": { "deprecated": true, "proto3_optional": true } } } }, "FulfillmentInfo": { "fields": { "type": { "type": "string", "id": 1 }, "placeIds": { "rule": "repeated", "type": "string", "id": 2 } } }, "Image": { "fields": { "uri": { "type": "string", "id": 1, "options": { "(google.api.field_behavior)": "REQUIRED" } }, "height": { "type": "int32", "id": 2 }, "width": { "type": "int32", "id": 3 } } }, "Interval": { "oneofs": { "min": { "oneof": [ "minimum", "exclusiveMinimum" ] }, "max": { "oneof": [ "maximum", "exclusiveMaximum" ] } }, "fields": { "minimum": { "type": "double", "id": 1 }, "exclusiveMinimum": { "type": "double", "id": 2 }, "maximum": { "type": "double", "id": 3 }, "exclusiveMaximum": { "type": "double", "id": 4 } } }, "PriceInfo": { "fields": { "currencyCode": { "type": "string", "id": 1 }, "price": { "type": "float", "id": 2 }, "originalPrice": { "type": "float", "id": 3 }, "cost": { "type": "float", "id": 4 }, "priceEffectiveTime": { "type": "google.protobuf.Timestamp", "id": 5 }, "priceExpireTime": { "type": "google.protobuf.Timestamp", "id": 6 }, "priceRange": { "type": "PriceRange", "id": 7, "options": { "(google.api.field_behavior)": "OUTPUT_ONLY" } } }, "nested": { "PriceRange": { "fields": { "price": { "type": "Interval", "id": 1 }, "originalPrice": { "type": "Interval", "id": 2 } } } } }, "Rating": { "fields": { "ratingCount": { "type": "int32", "id": 1 }, "averageRating": { "type": "float", "id": 2 }, "ratingHistogram": { "rule": "repeated", "type": "int32", "id": 3 } } }, "UserInfo": { "fields": { "userId": { "type": "string", "id": 1 }, "ipAddress": { "type": "string", "id": 2 }, "userAgent": { "type": "string", "id": 3 }, "directUserRequest": { "type": "bool", "id": 4 } } }, "LocalInventory": { "fields": { "placeId": { "type": "string", "id": 1, "options": { "(google.api.field_behavior)": "OPTIONAL" } }, "priceInfo": { "type": "PriceInfo", "id": 2, "options": { "(google.api.field_behavior)": "OPTIONAL" } }, "attributes": { "keyType": "string", "type": "CustomAttribute", "id": 3, "options": { "(google.api.field_behavior)": "OPTIONAL" } }, "fulfillmentTypes": { "rule": "repeated", "type": "string", "id": 4, "options": { "(google.api.field_behavior)": "OPTIONAL" } } } }, "PinControlMetadata": { "fields": { "allMatchedPins": { "keyType": "int64", "type": "ProductPins", "id": 1 }, "droppedPins": { "keyType": "int64", "type": "ProductPins", "id": 2 } }, "nested": { "ProductPins": { "fields": { "productId": { "rule": "repeated", "type": "string", "id": 1 } } } } }, "StringList": { "fields": { "values": { "rule": "repeated", "type": "string", "id": 1 } } }, "DoubleList": { "fields": { "values": { "rule": "repeated", "type": "double", "id": 1 } } }, "GcsSource": { "fields": { "inputUris": { "rule": "repeated", "type": "string", "id": 1, "options": { "(google.api.field_behavior)": "REQUIRED" } }, "dataSchema": { "type": "string", "id": 2 } } }, "BigQuerySource": { "oneofs": { "partition": { "oneof": [ "partitionDate" ] } }, "fields": { "partitionDate": { "type": "google.type.Date", "id": 6 }, "projectId": { "type": "string", "id": 5 }, "datasetId": { "type": "string", "id": 1, "options": { "(google.api.field_behavior)": "REQUIRED" } }, "tableId": { "type": "string", "id": 2, "options": { "(google.api.field_behavior)": "REQUIRED" } }, "gcsStagingDir": { "type": "string", "id": 3 }, "dataSchema": { "type": "string", "id": 4 } } }, "ProductInlineSource": { "fields": { "products": { "rule": "repeated", "type": "Product", "id": 1, "options": { "(google.api.field_behavior)": "REQUIRED" } } } }, "UserEventInlineSource": { "fields": { "userEvents": { "rule": "repeated", "type": "UserEvent", "id": 1, "options": { "(google.api.field_behavior)": "REQUIRED" } } } }, "ImportErrorsConfig": { "oneofs": { "destination": { "oneof": [ "gcsPrefix" ] } }, "fields": { "gcsPrefix": { "type": "string", "id": 1 } } }, "ImportProductsRequest": { "fields": { "parent": { "type": "string", "id": 1, "options": { "(google.api.field_behavior)": "REQUIRED", "(google.api.resource_reference).type": "retail.googleapis.com/Branch" } }, "requestId": { "type": "string", "id": 6, "options": { "deprecated": true } }, "inputConfig": { "type": "ProductInputConfig", "id": 2, "options": { "(google.api.field_behavior)": "REQUIRED" } }, "errorsConfig": { "type": "ImportErrorsConfig", "id": 3 }, "updateMask": { "type": "google.protobuf.FieldMask", "id": 4 }, "reconciliationMode": { "type": "ReconciliationMode", "id": 5 }, "notificationPubsubTopic": { "type": "string", "id": 7 } }, "nested": { "ReconciliationMode": { "values": { "RECONCILIATION_MODE_UNSPECIFIED": 0,