attributes_config_catalog_attribute

Creates, updates, deletes, gets or lists an attributes_config_catalog_attribute resource.

Overview

Name	attributes_config_catalog_attribute
Type	Resource
Id	google.retail.attributes_config_catalog_attribute

Fields

The following fields are returned by SELECT queries:

SELECT not supported for this resource, use SHOW METHODS to view available operations for the resource.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
projects_locations_catalogs_attributes_config_add_catalog_attribute	insert	projectsId, locationsId, catalogsId		Adds the specified CatalogAttribute to the AttributesConfig. If the CatalogAttribute to add already exists, an ALREADY_EXISTS error is returned.
projects_locations_catalogs_attributes_config_remove_catalog_attribute	delete	projectsId, locationsId, catalogsId		Removes the specified CatalogAttribute from the AttributesConfig. If the CatalogAttribute to remove does not exist, a NOT_FOUND error is returned.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
catalogsId	string
locationsId	string
projectsId	string

INSERT examples

projects_locations_catalogs_attributes_config_add_catalog_attribute

Adds the specified CatalogAttribute to the AttributesConfig. If the CatalogAttribute to add already exists, an ALREADY_EXISTS error is returned.

INSERT INTO google.retail.attributes_config_catalog_attribute (
data__catalogAttribute,
projectsId,
locationsId,
catalogsId
)
SELECT 
'{{ catalogAttribute }}',
'{{ projectsId }}',
'{{ locationsId }}',
'{{ catalogsId }}'
RETURNING
name,
attributeConfigLevel,
catalogAttributes
;

Manifest

# Description fields are for documentation purposes
- name: attributes_config_catalog_attribute
props:
  - name: projectsId
    value: "{{ projectsId }}"
    description: Required parameter for the attributes_config_catalog_attribute resource.
  - name: locationsId
    value: "{{ locationsId }}"
    description: Required parameter for the attributes_config_catalog_attribute resource.
  - name: catalogsId
    value: "{{ catalogsId }}"
    description: Required parameter for the attributes_config_catalog_attribute resource.
  - name: catalogAttribute
    description: |
      Required. The CatalogAttribute to add.
    value:
      exactSearchableOption: "{{ exactSearchableOption }}"
      inUse: {{ inUse }}
      searchableOption: "{{ searchableOption }}"
      key: "{{ key }}"
      indexableOption: "{{ indexableOption }}"
      type: "{{ type }}"
      dynamicFacetableOption: "{{ dynamicFacetableOption }}"
      retrievableOption: "{{ retrievableOption }}"
      facetConfig:
        ignoredFacetValues:
          - startTime: "{{ startTime }}"
            endTime: "{{ endTime }}"
            values: "{{ values }}"
        rerankConfig:
          rerankFacet: {{ rerankFacet }}
          facetValues:
            - "{{ facetValues }}"
        facetIntervals:
          - minimum: {{ minimum }}
            maximum: {{ maximum }}
            exclusiveMaximum: {{ exclusiveMaximum }}
            exclusiveMinimum: {{ exclusiveMinimum }}
        mergedFacetValues:
          - values: "{{ values }}"
            mergedValue: "{{ mergedValue }}"
        mergedFacet:
          mergedFacetKey: "{{ mergedFacetKey }}"

DELETE examples

projects_locations_catalogs_attributes_config_remove_catalog_attribute

Removes the specified CatalogAttribute from the AttributesConfig. If the CatalogAttribute to remove does not exist, a NOT_FOUND error is returned.

DELETE FROM google.retail.attributes_config_catalog_attribute
WHERE projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND catalogsId = '{{ catalogsId }}' --required
;