|
2059 | 2059 | }
|
2060 | 2060 | }
|
2061 | 2061 | },
|
2062 |
| - "revision": "20230810", |
| 2062 | + "revision": "20230831", |
2063 | 2063 | "rootUrl": "https://retail.googleapis.com/",
|
2064 | 2064 | "schemas": {
|
2065 | 2065 | "GoogleApiHttpBody": {
|
|
2449 | 2449 | ],
|
2450 | 2450 | "type": "string"
|
2451 | 2451 | },
|
| 2452 | + "facetConfig": { |
| 2453 | + "$ref": "GoogleCloudRetailV2CatalogAttributeFacetConfig", |
| 2454 | + "description": "Contains facet options." |
| 2455 | + }, |
2452 | 2456 | "inUse": {
|
2453 | 2457 | "description": "Output only. Indicates whether this attribute has been used by any products. `True` if at least one Product is using this attribute in Product.attributes. Otherwise, this field is `False`. CatalogAttribute can be pre-loaded by using CatalogService.AddCatalogAttribute, CatalogService.ImportCatalogAttributes, or CatalogService.UpdateAttributesConfig APIs. This field is `False` for pre-loaded CatalogAttributes. Only pre-loaded catalog attributes that are neither in use by products nor predefined can be deleted. Catalog attributes that are either in use by products or are predefined attributes cannot be deleted; however, their configuration properties will reset to default values upon removal request. After catalog changes, it takes about 10 minutes for this field to update.",
|
2454 | 2458 | "readOnly": true,
|
|
2518 | 2522 | },
|
2519 | 2523 | "type": "object"
|
2520 | 2524 | },
|
| 2525 | + "GoogleCloudRetailV2CatalogAttributeFacetConfig": { |
| 2526 | + "description": "Possible options for the facet that corresponds to the current attribute config.", |
| 2527 | + "id": "GoogleCloudRetailV2CatalogAttributeFacetConfig", |
| 2528 | + "properties": { |
| 2529 | + "facetIntervals": { |
| 2530 | + "description": "If you don't set the facet SearchRequest.FacetSpec.FacetKey.intervals in the request to a numerical attribute, then we use the computed intervals with rounded bounds obtained from all its product numerical attribute values. The computed intervals might not be ideal for some attributes. Therefore, we give you the option to overwrite them with the facet_intervals field. The maximum of facet intervals per CatalogAttribute is 40. Each interval must have a lower bound or an upper bound. If both bounds are provided, then the lower bound must be smaller or equal than the upper bound.", |
| 2531 | + "items": { |
| 2532 | + "$ref": "GoogleCloudRetailV2Interval" |
| 2533 | + }, |
| 2534 | + "type": "array" |
| 2535 | + }, |
| 2536 | + "ignoredFacetValues": { |
| 2537 | + "description": "Each instance represents a list of attribute values to ignore as facet values for a specific time range. The maximum number of instances per CatalogAttribute is 25.", |
| 2538 | + "items": { |
| 2539 | + "$ref": "GoogleCloudRetailV2CatalogAttributeFacetConfigIgnoredFacetValues" |
| 2540 | + }, |
| 2541 | + "type": "array" |
| 2542 | + }, |
| 2543 | + "mergedFacetValues": { |
| 2544 | + "description": "Each instance replaces a list of facet values by a merged facet value. If a facet value is not in any list, then it will stay the same. To avoid conflicts, only paths of length 1 are accepted. In other words, if \"dark_blue\" merged into \"BLUE\", then the latter can't merge into \"blues\" because this would create a path of length 2. The maximum number of instances of MergedFacetValue per CatalogAttribute is 100.", |
| 2545 | + "items": { |
| 2546 | + "$ref": "GoogleCloudRetailV2CatalogAttributeFacetConfigMergedFacetValue" |
| 2547 | + }, |
| 2548 | + "type": "array" |
| 2549 | + } |
| 2550 | + }, |
| 2551 | + "type": "object" |
| 2552 | + }, |
| 2553 | + "GoogleCloudRetailV2CatalogAttributeFacetConfigIgnoredFacetValues": { |
| 2554 | + "description": "Facet values to ignore on facets during the specified time range for the given SearchResponse.Facet.key attribute.", |
| 2555 | + "id": "GoogleCloudRetailV2CatalogAttributeFacetConfigIgnoredFacetValues", |
| 2556 | + "properties": { |
| 2557 | + "endTime": { |
| 2558 | + "description": "If start time is empty and end time is not empty, then ignore these facet values before end time.", |
| 2559 | + "format": "google-datetime", |
| 2560 | + "type": "string" |
| 2561 | + }, |
| 2562 | + "startTime": { |
| 2563 | + "description": "Time range for the current list of facet values to ignore. If multiple time ranges are specified for an facet value for the current attribute, consider all of them. If both are empty, ignore always. If start time and end time are set, then start time must be before end time. If start time is not empty and end time is empty, then will ignore these facet values after the start time.", |
| 2564 | + "format": "google-datetime", |
| 2565 | + "type": "string" |
| 2566 | + }, |
| 2567 | + "values": { |
| 2568 | + "description": "List of facet values to ignore for the following time range. The facet values are the same as the attribute values. There is a limit of 10 values per instance of IgnoredFacetValues. Each value can have at most 60 characters.", |
| 2569 | + "items": { |
| 2570 | + "type": "string" |
| 2571 | + }, |
| 2572 | + "type": "array" |
| 2573 | + } |
| 2574 | + }, |
| 2575 | + "type": "object" |
| 2576 | + }, |
| 2577 | + "GoogleCloudRetailV2CatalogAttributeFacetConfigMergedFacetValue": { |
| 2578 | + "description": "Replaces a set of facet values by the same (possibly different) merged facet value. Each facet value should appear at most once as a value per CatalogAttribute.", |
| 2579 | + "id": "GoogleCloudRetailV2CatalogAttributeFacetConfigMergedFacetValue", |
| 2580 | + "properties": { |
| 2581 | + "mergedValue": { |
| 2582 | + "description": "All the previous values are replaced by this merged facet value. This merged_value must be non-empty and can have up to 60 characters.", |
| 2583 | + "type": "string" |
| 2584 | + }, |
| 2585 | + "values": { |
| 2586 | + "description": "All the facet values that are replaces by the same merged_value that follows. The maximum number of values per MergedFacetValue is 25. Each value can have up to 60 characters.", |
| 2587 | + "items": { |
| 2588 | + "type": "string" |
| 2589 | + }, |
| 2590 | + "type": "array" |
| 2591 | + } |
| 2592 | + }, |
| 2593 | + "type": "object" |
| 2594 | + }, |
2521 | 2595 | "GoogleCloudRetailV2ColorInfo": {
|
2522 | 2596 | "description": "The color information of a Product.",
|
2523 | 2597 | "id": "GoogleCloudRetailV2ColorInfo",
|
|
2696 | 2770 | },
|
2697 | 2771 | "type": "array"
|
2698 | 2772 | },
|
| 2773 | + "pageCategories": { |
| 2774 | + "description": "Used to support browse uses cases. A list (up to 10 entries) of categories or departments. The format should be the same as UserEvent.page_categories;", |
| 2775 | + "items": { |
| 2776 | + "type": "string" |
| 2777 | + }, |
| 2778 | + "type": "array" |
| 2779 | + }, |
2699 | 2780 | "queryTerms": {
|
2700 | 2781 | "description": "A list (up to 10 entries) of terms to match the query on. If not specified, match all queries. If many query terms are specified, the condition is matched if any of the terms is a match (i.e. using the OR operator).",
|
2701 | 2782 | "items": {
|
|
4222 | 4303 | "$ref": "GoogleCloudRetailV2RuleFilterAction",
|
4223 | 4304 | "description": "Filters results."
|
4224 | 4305 | },
|
| 4306 | + "forceReturnFacetAction": { |
| 4307 | + "$ref": "GoogleCloudRetailV2RuleForceReturnFacetAction", |
| 4308 | + "description": "Force returns an attribute as a facet in the request." |
| 4309 | + }, |
4225 | 4310 | "ignoreAction": {
|
4226 | 4311 | "$ref": "GoogleCloudRetailV2RuleIgnoreAction",
|
4227 | 4312 | "description": "Ignores specific terms from query during search."
|
|
4234 | 4319 | "$ref": "GoogleCloudRetailV2RuleRedirectAction",
|
4235 | 4320 | "description": "Redirects a shopper to a specific page."
|
4236 | 4321 | },
|
| 4322 | + "removeFacetAction": { |
| 4323 | + "$ref": "GoogleCloudRetailV2RuleRemoveFacetAction", |
| 4324 | + "description": "Remove an attribute as a facet in the request (if present)." |
| 4325 | + }, |
4237 | 4326 | "replacementAction": {
|
4238 | 4327 | "$ref": "GoogleCloudRetailV2RuleReplacementAction",
|
4239 | 4328 | "description": "Replaces specific terms in the query."
|
|
4300 | 4389 | },
|
4301 | 4390 | "type": "object"
|
4302 | 4391 | },
|
| 4392 | + "GoogleCloudRetailV2RuleForceReturnFacetAction": { |
| 4393 | + "description": "Force returns an attribute/facet in the request around a certain position or above. * Rule Condition: - Must specify non-empty Condition.query_terms (for search only) or Condition.page_categories (for browse only), but can't specify both. * Action Inputs: attribute name, position * Action Result: Will force return a facet key around a certain position or above if the condition is satisfied. Example: Suppose the query is \"shoes\", the Condition.query_terms is \"shoes\", the ForceReturnFacetAction.FacetPositionAdjustment.attribute_name is \"size\" and the ForceReturnFacetAction.FacetPositionAdjustment.position is 8. Two cases: a) The facet key \"size\" is not already in the top 8 slots, then the facet \"size\" will appear at a position close to 8. b) The facet key \"size\" in among the top 8 positions in the request, then it will stay at its current rank.", |
| 4394 | + "id": "GoogleCloudRetailV2RuleForceReturnFacetAction", |
| 4395 | + "properties": { |
| 4396 | + "facetPositionAdjustments": { |
| 4397 | + "description": "Each instance corresponds to a force return attribute for the given condition. There can't be more 3 instances here.", |
| 4398 | + "items": { |
| 4399 | + "$ref": "GoogleCloudRetailV2RuleForceReturnFacetActionFacetPositionAdjustment" |
| 4400 | + }, |
| 4401 | + "type": "array" |
| 4402 | + } |
| 4403 | + }, |
| 4404 | + "type": "object" |
| 4405 | + }, |
| 4406 | + "GoogleCloudRetailV2RuleForceReturnFacetActionFacetPositionAdjustment": { |
| 4407 | + "description": "Each facet position adjustment consists of a single attribute name (i.e. facet key) along with a specified position.", |
| 4408 | + "id": "GoogleCloudRetailV2RuleForceReturnFacetActionFacetPositionAdjustment", |
| 4409 | + "properties": { |
| 4410 | + "attributeName": { |
| 4411 | + "description": "The attribute name to force return as a facet. Each attribute name should be a valid attribute name, be non-empty and contain at most 80 characters long.", |
| 4412 | + "type": "string" |
| 4413 | + }, |
| 4414 | + "position": { |
| 4415 | + "description": "This is the position in the request as explained above. It should be strictly positive be at most 100.", |
| 4416 | + "format": "int32", |
| 4417 | + "type": "integer" |
| 4418 | + } |
| 4419 | + }, |
| 4420 | + "type": "object" |
| 4421 | + }, |
4303 | 4422 | "GoogleCloudRetailV2RuleIgnoreAction": {
|
4304 | 4423 | "description": "Prevents a term in the query from being used in search. Example: Don't search for \"shoddy\".",
|
4305 | 4424 | "id": "GoogleCloudRetailV2RuleIgnoreAction",
|
|
4353 | 4472 | },
|
4354 | 4473 | "type": "object"
|
4355 | 4474 | },
|
| 4475 | + "GoogleCloudRetailV2RuleRemoveFacetAction": { |
| 4476 | + "description": "Removes an attribute/facet in the request if is present. * Rule Condition: - Must specify non-empty Condition.query_terms (for search only) or Condition.page_categories (for browse only), but can't specify both. * Action Input: attribute name * Action Result: Will remove the attribute (as a facet) from the request if it is present. Example: Suppose the query is \"shoes\", the Condition.query_terms is \"shoes\" and the attribute name \"size\", then facet key \"size\" will be removed from the request (if it is present).", |
| 4477 | + "id": "GoogleCloudRetailV2RuleRemoveFacetAction", |
| 4478 | + "properties": { |
| 4479 | + "attributeNames": { |
| 4480 | + "description": "The attribute names (i.e. facet keys) to remove from the dynamic facets (if present in the request). There can't be more 3 attribute names. Each attribute name should be a valid attribute name, be non-empty and contain at most 80 characters.", |
| 4481 | + "items": { |
| 4482 | + "type": "string" |
| 4483 | + }, |
| 4484 | + "type": "array" |
| 4485 | + } |
| 4486 | + }, |
| 4487 | + "type": "object" |
| 4488 | + }, |
4356 | 4489 | "GoogleCloudRetailV2RuleReplacementAction": {
|
4357 | 4490 | "description": "Replaces a term in the query. Multiple replacement candidates can be specified. All `query_terms` will be replaced with the replacement term. Example: Replace \"gShoe\" with \"google shoe\".",
|
4358 | 4491 | "id": "GoogleCloudRetailV2RuleReplacementAction",
|
|
0 commit comments