1 API Parameters
_
2 Resources
2.1 products
shopping-products-list
shopping-products-get
Version: 5.3

Search API For Shopping v1

This documentation has been automatically generated using information supplied by the Google API Discovery service.

Lets you search over product data. Google documentation.

    1 API Parameters

    2 Resources

      2.1 products

(require-gapi-doc "shopping.v1.js")

1 API Parameters

The following optional keyword arguments may be passed to all functions for this web service:

procedure

(_ [#:alt alt    
  #:fields fields    
  #:key key    
  #:oauth_token oauth_token    
  #:prettyPrint prettyPrint    
  #:quotaUser quotaUser    
  #:userIp userIp])  jsexpr?
  alt : string? = 'N/A
  fields : string? = 'N/A
  key : string? = (api-key)
  oauth_token : string? = 'N/A
  prettyPrint : string? = 'N/A
  quotaUser : string? = 'N/A
  userIp : string? = 'N/A

This is not actually a function. This is just using Scribble’s defproc form to list the optional keyword arguments that may be passed to all functions for this service.

alt: Data format for the response.

fields: Selector specifying which fields to include in a partial response.

key: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

oauth_token: OAuth 2.0 token for the current user.

prettyPrint: Returns response with indentations and line breaks.

quotaUser: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.

userIp: IP address of the site where the request originates. Use this if you want to enforce per-user limits.

2 Resources

2.1 products

procedure

(shopping-products-list 
  #:source source 
  [#:q q 
  #:language language 
  #:thumbnails thumbnails 
  #:availability availability 
  #:country country 
  #:attributeFilter attributeFilter 
  #:categories.enabled categories.enabled 
  #:categories.include categories.include 
  #:categories.useGcsConfig categories.useGcsConfig 
  #:plusOne.enabled plusOne.enabled 
  #:plusOne.styles plusOne.styles 
  #:plusOne.useGcsConfig plusOne.useGcsConfig 
  #:taxonomy taxonomy 
  #:boostBy boostBy 
  #:categoryRecommendations.category categoryRecommendations.category 
  #:categoryRecommendations.enabled categoryRecommendations.enabled 
  #:categoryRecommendations.include categoryRecommendations.include 
  #:categoryRecommendations.useGcsConfig categoryRecommendations.useGcsConfig 
  #:channels channels 
  #:clickTracking clickTracking 
  #:crowdBy crowdBy 
  #:facets.discover facets.discover 
  #:facets.enabled facets.enabled 
  #:facets.include facets.include 
  #:facets.useGcsConfig facets.useGcsConfig 
  #:maxVariants maxVariants 
  #:promotions.enabled promotions.enabled 
  #:promotions.useGcsConfig promotions.useGcsConfig 
  #:rankBy rankBy 
  #:redirects.enabled redirects.enabled 
  #:redirects.useGcsConfig redirects.useGcsConfig 
  #:relatedQueries.enabled relatedQueries.enabled 
  #:relatedQueries.useGcsConfig relatedQueries.useGcsConfig 
  #:restrictBy restrictBy 
  #:safe safe 
  #:spelling.enabled spelling.enabled 
  #:spelling.useGcsConfig spelling.useGcsConfig 
  #:useCase useCase 
  #:location location 
  #:currency currency 
  #:startIndex startIndex 
  #:maxResults maxResults 
  #:alt alt 
  #:fields fields 
  #:key key 
  #:oauth_token oauth_token 
  #:prettyPrint prettyPrint 
  #:quotaUser quotaUser 
  #:userIp userIp]) 
  jsexpr?
  source : string?
  q : string? = 'N/A
  language : string? = 'N/A
  thumbnails : string? = 'N/A
  availability : string? = 'N/A
  country : string? = 'N/A
  attributeFilter : string? = 'N/A
  categories.enabled : string? = 'N/A
  categories.include : string? = 'N/A
  categories.useGcsConfig : string? = 'N/A
  plusOne.enabled : string? = 'N/A
  plusOne.styles : string? = 'N/A
  plusOne.useGcsConfig : string? = 'N/A
  taxonomy : string? = 'N/A
  boostBy : string? = 'N/A
  categoryRecommendations.category : string? = 'N/A
  categoryRecommendations.enabled : string? = 'N/A
  categoryRecommendations.include : string? = 'N/A
  categoryRecommendations.useGcsConfig : string? = 'N/A
  channels : string? = 'N/A
  clickTracking : string? = 'N/A
  crowdBy : string? = 'N/A
  facets.discover : string? = 'N/A
  facets.enabled : string? = 'N/A
  facets.include : string? = 'N/A
  facets.useGcsConfig : string? = 'N/A
  maxVariants : string? = 'N/A
  promotions.enabled : string? = 'N/A
  promotions.useGcsConfig : string? = 'N/A
  rankBy : string? = 'N/A
  redirects.enabled : string? = 'N/A
  redirects.useGcsConfig : string? = 'N/A
  relatedQueries.enabled : string? = 'N/A
  relatedQueries.useGcsConfig : string? = 'N/A
  restrictBy : string? = 'N/A
  safe : string? = 'N/A
  spelling.enabled : string? = 'N/A
  spelling.useGcsConfig : string? = 'N/A
  useCase : string? = 'N/A
  location : string? = 'N/A
  currency : string? = 'N/A
  startIndex : string? = 'N/A
  maxResults : string? = 'N/A
  alt : string? = 'N/A
  fields : string? = 'N/A
  key : string? = (api-key)
  oauth_token : string? = 'N/A
  prettyPrint : string? = 'N/A
  quotaUser : string? = 'N/A
  userIp : string? = 'N/A
Returns a list of products and content modules

source: Query source

q: Search query

language: Language restriction (BCP 47)

thumbnails: Image thumbnails specification

availability: Comma separated list of availabilities (outOfStock, limited, inStock, backOrder, preOrder, onDisplayToOrder) to return

country: Country restriction (ISO 3166)

attributeFilter: Comma separated list of attributes to return

categories.enabled: Whether to return category information

categories.include: Category specification

categories.useGcsConfig: This parameter is currently ignored

plusOne.enabled: Whether to return +1 button code

plusOne.styles: +1 button rendering styles

plusOne.useGcsConfig: Whether to use +1 button styles configured in the GCS account

taxonomy: Taxonomy name

boostBy: Boosting specification

categoryRecommendations.category: Category for which to retrieve recommendations

categoryRecommendations.enabled: Whether to return category recommendation information

categoryRecommendations.include: Category recommendation specification

categoryRecommendations.useGcsConfig: This parameter is currently ignored

channels: Channels specification

clickTracking: Whether to add a click tracking parameter to offer URLs

crowdBy: Crowding specification

facets.discover: Facets to discover

facets.enabled: Whether to return facet information

facets.include: Facets to include (applies when useGcsConfig == false)

facets.useGcsConfig: Whether to return facet information as configured in the GCS account

maxVariants: Maximum number of variant results to return per result

promotions.enabled: Whether to return promotion information

promotions.useGcsConfig: Whether to return promotion information as configured in the GCS account

rankBy: Ranking specification

redirects.enabled: Whether to return redirect information

redirects.useGcsConfig: Whether to return redirect information as configured in the GCS account

relatedQueries.enabled: Whether to return related queries

relatedQueries.useGcsConfig: This parameter is currently ignored

restrictBy: Restriction specification

safe: Whether safe search is enabled. Default: true

spelling.enabled: Whether to return spelling suggestions

spelling.useGcsConfig: This parameter is currently ignored

useCase: One of CommerceSearchUseCase, ShoppingApiUseCase

location: Location used to determine tax and shipping

currency: Currency restriction (ISO 4217)

startIndex: Index (1-based) of first product to return

maxResults: Maximum number of results to return

procedure

(shopping-products-get 
  #:productId productId 
  #:productIdType productIdType 
  #:accountId accountId 
  #:source source 
  [#:thumbnails thumbnails 
  #:attributeFilter attributeFilter 
  #:categories.enabled categories.enabled 
  #:categories.include categories.include 
  #:categories.useGcsConfig categories.useGcsConfig 
  #:plusOne.enabled plusOne.enabled 
  #:plusOne.styles plusOne.styles 
  #:plusOne.useGcsConfig plusOne.useGcsConfig 
  #:recommendations.enabled recommendations.enabled 
  #:recommendations.include recommendations.include 
  #:recommendations.useGcsConfig recommendations.useGcsConfig 
  #:taxonomy taxonomy 
  #:location location 
  #:alt alt 
  #:fields fields 
  #:key key 
  #:oauth_token oauth_token 
  #:prettyPrint prettyPrint 
  #:quotaUser quotaUser 
  #:userIp userIp]) 
  jsexpr?
  productId : string?
  productIdType : string?
  accountId : string?
  source : string?
  thumbnails : string? = 'N/A
  attributeFilter : string? = 'N/A
  categories.enabled : string? = 'N/A
  categories.include : string? = 'N/A
  categories.useGcsConfig : string? = 'N/A
  plusOne.enabled : string? = 'N/A
  plusOne.styles : string? = 'N/A
  plusOne.useGcsConfig : string? = 'N/A
  recommendations.enabled : string? = 'N/A
  recommendations.include : string? = 'N/A
  recommendations.useGcsConfig : string? = 'N/A
  taxonomy : string? = 'N/A
  location : string? = 'N/A
  alt : string? = 'N/A
  fields : string? = 'N/A
  key : string? = (api-key)
  oauth_token : string? = 'N/A
  prettyPrint : string? = 'N/A
  quotaUser : string? = 'N/A
  userIp : string? = 'N/A
Returns a single product

productId: Id of product

productIdType: Type of productId

accountId: Merchant center account id

source: Query source

thumbnails: Thumbnail specification

attributeFilter: Comma separated list of attributes to return

categories.enabled: Whether to return category information

categories.include: Category specification

categories.useGcsConfig: This parameter is currently ignored

plusOne.enabled: Whether to return +1 button code

plusOne.styles: +1 button rendering styles

plusOne.useGcsConfig: Whether to use +1 button styles configured in the GCS account

recommendations.enabled: Whether to return recommendation information

recommendations.include: Recommendation specification

recommendations.useGcsConfig: This parameter is currently ignored

taxonomy: Merchant taxonomy

location: Location used to determine tax and shipping