Search

    Response to a custom search request.

    JSON representation 
     { 
 "kind" 
 : 
 string 
 , 
 "url" 
 : 
 { 
 "type" 
 : 
 string 
 , 
 "template" 
 : 
 string 
 } 
 , 
 "queries" 
 : 
 { 
 "previousPage" 
 : 
 [ 
 { 
 "title" 
 : 
 string 
 , 
 "totalResults" 
 : 
 string 
 , 
 "searchTerms" 
 : 
 string 
 , 
 "count" 
 : 
 integer 
 , 
 "startIndex" 
 : 
 integer 
 , 
 "startPage" 
 : 
 integer 
 , 
 "language" 
 : 
 string 
 , 
 "inputEncoding" 
 : 
 string 
 , 
 "outputEncoding" 
 : 
 string 
 , 
 "safe" 
 : 
 string 
 , 
 "cx" 
 : 
 string 
 , 
 "sort" 
 : 
 string 
 , 
 "filter" 
 : 
 string 
 , 
 "gl" 
 : 
 string 
 , 
 "cr" 
 : 
 string 
 , 
 "googleHost" 
 : 
 string 
 , 
 "disableCnTwTranslation" 
 : 
 string 
 , 
 "hq" 
 : 
 string 
 , 
 "hl" 
 : 
 string 
 , 
 "siteSearch" 
 : 
 string 
 , 
 "siteSearchFilter" 
 : 
 string 
 , 
 "exactTerms" 
 : 
 string 
 , 
 "excludeTerms" 
 : 
 string 
 , 
 "linkSite" 
 : 
 string 
 , 
 "orTerms" 
 : 
 string 
 , 
 "relatedSite" 
 : 
 string 
 , 
 "dateRestrict" 
 : 
 string 
 , 
 "lowRange" 
 : 
 string 
 , 
 "highRange" 
 : 
 string 
 , 
 "fileType" 
 : 
 string 
 , 
 "rights" 
 : 
 string 
 , 
 "searchType" 
 : 
 string 
 , 
 "imgSize" 
 : 
 string 
 , 
 "imgType" 
 : 
 string 
 , 
 "imgColorType" 
 : 
 string 
 , 
 "imgDominantColor" 
 : 
 string 
 } 
 ] 
 , 
 "request" 
 : 
 [ 
 { 
 "title" 
 : 
 string 
 , 
 "totalResults" 
 : 
 string 
 , 
 "searchTerms" 
 : 
 string 
 , 
 "count" 
 : 
 integer 
 , 
 "startIndex" 
 : 
 integer 
 , 
 "startPage" 
 : 
 integer 
 , 
 "language" 
 : 
 string 
 , 
 "inputEncoding" 
 : 
 string 
 , 
 "outputEncoding" 
 : 
 string 
 , 
 "safe" 
 : 
 string 
 , 
 "cx" 
 : 
 string 
 , 
 "sort" 
 : 
 string 
 , 
 "filter" 
 : 
 string 
 , 
 "gl" 
 : 
 string 
 , 
 "cr" 
 : 
 string 
 , 
 "googleHost" 
 : 
 string 
 , 
 "disableCnTwTranslation" 
 : 
 string 
 , 
 "hq" 
 : 
 string 
 , 
 "hl" 
 : 
 string 
 , 
 "siteSearch" 
 : 
 string 
 , 
 "siteSearchFilter" 
 : 
 string 
 , 
 "exactTerms" 
 : 
 string 
 , 
 "excludeTerms" 
 : 
 string 
 , 
 "linkSite" 
 : 
 string 
 , 
 "orTerms" 
 : 
 string 
 , 
 "relatedSite" 
 : 
 string 
 , 
 "dateRestrict" 
 : 
 string 
 , 
 "lowRange" 
 : 
 string 
 , 
 "highRange" 
 : 
 string 
 , 
 "fileType" 
 : 
 string 
 , 
 "rights" 
 : 
 string 
 , 
 "searchType" 
 : 
 string 
 , 
 "imgSize" 
 : 
 string 
 , 
 "imgType" 
 : 
 string 
 , 
 "imgColorType" 
 : 
 string 
 , 
 "imgDominantColor" 
 : 
 string 
 } 
 ] 
 , 
 "nextPage" 
 : 
 [ 
 { 
 "title" 
 : 
 string 
 , 
 "totalResults" 
 : 
 string 
 , 
 "searchTerms" 
 : 
 string 
 , 
 "count" 
 : 
 integer 
 , 
 "startIndex" 
 : 
 integer 
 , 
 "startPage" 
 : 
 integer 
 , 
 "language" 
 : 
 string 
 , 
 "inputEncoding" 
 : 
 string 
 , 
 "outputEncoding" 
 : 
 string 
 , 
 "safe" 
 : 
 string 
 , 
 "cx" 
 : 
 string 
 , 
 "sort" 
 : 
 string 
 , 
 "filter" 
 : 
 string 
 , 
 "gl" 
 : 
 string 
 , 
 "cr" 
 : 
 string 
 , 
 "googleHost" 
 : 
 string 
 , 
 "disableCnTwTranslation" 
 : 
 string 
 , 
 "hq" 
 : 
 string 
 , 
 "hl" 
 : 
 string 
 , 
 "siteSearch" 
 : 
 string 
 , 
 "siteSearchFilter" 
 : 
 string 
 , 
 "exactTerms" 
 : 
 string 
 , 
 "excludeTerms" 
 : 
 string 
 , 
 "linkSite" 
 : 
 string 
 , 
 "orTerms" 
 : 
 string 
 , 
 "relatedSite" 
 : 
 string 
 , 
 "dateRestrict" 
 : 
 string 
 , 
 "lowRange" 
 : 
 string 
 , 
 "highRange" 
 : 
 string 
 , 
 "fileType" 
 : 
 string 
 , 
 "rights" 
 : 
 string 
 , 
 "searchType" 
 : 
 string 
 , 
 "imgSize" 
 : 
 string 
 , 
 "imgType" 
 : 
 string 
 , 
 "imgColorType" 
 : 
 string 
 , 
 "imgDominantColor" 
 : 
 string 
 } 
 ] 
 } 
 , 
 "promotions" 
 : 
 [ 
 { 
 object (  Promotion 
 
) 
 } 
 ] 
 , 
 "context" 
 : 
 { 
 object 
 } 
 , 
 "searchInformation" 
 : 
 { 
 "searchTime" 
 : 
 number 
 , 
 "formattedSearchTime" 
 : 
 string 
 , 
 "totalResults" 
 : 
 string 
 , 
 "formattedTotalResults" 
 : 
 string 
 } 
 , 
 "spelling" 
 : 
 { 
 "correctedQuery" 
 : 
 string 
 , 
 "htmlCorrectedQuery" 
 : 
 string 
 } 
 , 
 "items" 
 : 
 [ 
 { 
 object (  Result 
 
) 
 } 
 ] 
 }
    Fields
    kind

    string

    Unique identifier for the type of current object. For this API, it is customsearch#search.

    url

    object

    The OpenSearch URL element that defines the template for this API.

    url.type

    string

    The MIME type of the OpenSearch URL template for the Custom Search JSON API.

    url.template

    string

    The actual OpenSearch template for this API.

    queries

    object

    Contains one or more sets of query metadata, keyed by role name. The possible role names include request defined by the OpenSearch query roles and two custom roles: nextPage and previousPage .

    queries.previousPage[]

    object

    Metadata representing the previous page of results, if applicable.

    queries.previousPage[].title

    string

    A description of the query.

    queries.previousPage[].totalResults

    string ( int64 format)

    Estimated number of total search results. May not be accurate.

    queries.previousPage[].searchTerms

    string

    The search terms entered by the user.

    queries.previousPage[].count

    integer

    Number of search results returned in this set.

    queries.previousPage[].startIndex

    integer

    The index of the current set of search results into the total set of results, where the index of the first result is 1.

    queries.previousPage[].startPage

    integer

    The page number of this set of results, where the page length is set by the count property.

    queries.previousPage[].language

    string

    The language of the search results.

    queries.previousPage[].inputEncoding

    string

    The character encoding supported for search requests.

    queries.previousPage[].outputEncoding

    string

    The character encoding supported for search results.

    queries.previousPage[].safe

    string

    Specifies the SafeSearch level used for filtering out adult results. This is a custom property not defined in the OpenSearch spec. Valid parameter values are:

    • "off" : Disable SafeSearch

    • "active" : Enable SafeSearch

    queries.previousPage[].cx

    string

    The identifier of an engine created using the Programmable Search Engine Control Panel . This is a custom property not defined in the OpenSearch spec. This parameter is required.

    queries.previousPage[].sort

    string

    Specifies that results should be sorted according to the specified expression. For example, sort by date.

    queries.previousPage[].filter

    string

    Activates or deactivates the automatic filtering of Google search results. See Automatic Filtering for more information about Google's search results filters. Valid values for this parameter are:

    • 0 : Disabled

    • 1 : Enabled (default)

    Note: By default, Google applies filtering to all search results to improve the quality of those results.

    queries.previousPage[].gl

    string

    Boosts search results whose country of origin matches the parameter value. See Country Codes for a list of valid values.

    Specifying a gl parameter value in WebSearch requests should improve the relevance of results. This is particularly true for international customers and, even more specifically, for customers in English-speaking countries other than the United States.

    queries.previousPage[].cr

    string

    Restricts search results to documents originating in a particular country. You may use Boolean operators in the cr parameter's value.

    Google WebSearch determines the country of a document by analyzing the following:

    • The top-level domain (TLD) of the document's URL.

    • The geographic location of the web server's IP address.

    See Country (cr) Parameter Values for a list of valid values for this parameter.

    queries.previousPage[].googleHost

    string

    Specifies the Google domain (for example, google.com, google.de, or google.fr) to which the search should be limited.

    queries.previousPage[].disableCnTwTranslation

    string

    Enables or disables the Simplified and Traditional Chinese Search feature.

    Supported values are:

    • 0 : enabled (default)

    • 1 : disabled

    queries.previousPage[].hq

    string

    Appends the specified query terms to the query, as if they were combined with a logical AND operator.

    queries.previousPage[].hl

    string

    Specifies the interface language (host language) of your user interface. Explicitly setting this parameter improves the performance and the quality of your search results.

    See the Interface Languages section of Internationalizing Queries and Results Presentation for more information, and Supported Interface Languages for a list of supported languages.

    queries.previousPage[].siteSearch

    string

    Restricts results to URLs from a specified site.

    queries.previousPage[].siteSearchFilter

    string

    Specifies whether to include or exclude results from the site named in the sitesearch parameter. Supported values are:

    • i : include content from site

    • e : exclude content from site

    queries.previousPage[].exactTerms

    string

    Identifies a phrase that all documents in the search results must contain.

    queries.previousPage[].excludeTerms

    string

    Identifies a word or phrase that should not appear in any documents in the search results.

    queries.previousPage[].linkSite

    string

    Specifies that all results should contain a link to a specific URL.

    queries.previousPage[].orTerms

    string

    Provides additional search terms to check for in a document, where each document in the search results must contain at least one of the additional search terms. You can also use the Boolean OR query term for this type of query.

    queries.previousPage[].relatedSite

    string

    Specifies that all search results should be pages that are related to the specified URL. The parameter value should be a URL.

    queries.previousPage[].dateRestrict

    string

    Restricts results to URLs based on date. Supported values include:

    • d[number] : requests results from the specified number of past days.

    • w[number] : requests results from the specified number of past weeks.

    • m[number] : requests results from the specified number of past months.

    • y[number] : requests results from the specified number of past years.

    queries.previousPage[].lowRange

    string

    Specifies the starting value for a search range. Use cse:lowRange and cse:highrange to append an inclusive search range of lowRange...highRange to the query.

    queries.previousPage[].highRange

    string

    Specifies the ending value for a search range. Use cse:lowRange and cse:highrange to append an inclusive search range of lowRange...highRange to the query.

    queries.previousPage[].fileType

    string

    Restricts results to files of a specified extension. Filetypes supported by Google include:

    • Adobe Portable Document Format ( pdf )

    • Adobe PostScript ( ps )

    • Lotus 1-2-3 ( wk1 , wk2 , wk3 , wk4 , wk5 , wki , wks , wku )

    • Lotus WordPro ( lwp )

    • Macwrite ( mw )

    • Microsoft Excel ( xls )

    • Microsoft PowerPoint ( ppt )

    • Microsoft Word ( doc )

    • Microsoft Works ( wks , wps , wdb )

    • Microsoft Write ( wri )

    • Rich Text Format ( rtf )

    • Shockwave Flash ( swf )

    • Text ( ans , txt ).

    Additional filetypes may be added in the future. An up-to-date list can always be found in Google's file type FAQ .

    queries.previousPage[].rights

    string

    Filters based on licensing. Supported values include:

    • cc_publicdomain

    • cc_attribute

    • cc_sharealike

    • cc_noncommercial

    • cc_nonderived

    queries.previousPage[].searchType

    string

    Allowed values are web or image . If unspecified, results are limited to webpages.

    queries.previousPage[].imgSize

    string

    Restricts results to images of a specified size. Supported values are:

    • icon (small)

    • small | medium | large | xlarge (medium)

    • xxlarge (large)

    • huge (extra-large)

    queries.previousPage[].imgType

    string

    Restricts results to images of a specified type. Supported values are:

    • clipart (Clip art)

    • face (Face)

    • lineart (Line drawing)

    • photo (Photo)

    • animated (Animated)

    • stock (Stock)

    queries.previousPage[].imgColorType

    string

    Restricts results to images of a specified color type. Supported values are:

    • mono (black and white)

    • gray (grayscale)

    • color (color)

    queries.previousPage[].imgDominantColor

    string

    Restricts results to images with a specific dominant color. Supported values are:

    • red

    • orange

    • yellow

    • green

    • teal

    • blue

    • purple

    • pink

    • white

    • gray

    • black

    • brown

    queries.request[]

    object

    Metadata representing the current request.

    queries.request[].title

    string

    A description of the query.

    queries.request[].totalResults

    string ( int64 format)

    Estimated number of total search results. May not be accurate.

    queries.request[].searchTerms

    string

    The search terms entered by the user.

    queries.request[].count

    integer

    Number of search results returned in this set.

    queries.request[].startIndex

    integer

    The index of the current set of search results into the total set of results, where the index of the first result is 1.

    queries.request[].startPage

    integer

    The page number of this set of results, where the page length is set by the count property.

    queries.request[].language

    string

    The language of the search results.

    queries.request[].inputEncoding

    string

    The character encoding supported for search requests.

    queries.request[].outputEncoding

    string

    The character encoding supported for search results.

    queries.request[].safe

    string

    Specifies the SafeSearch level used for filtering out adult results. This is a custom property not defined in the OpenSearch spec. Valid parameter values are:

    • "off" : Disable SafeSearch

    • "active" : Enable SafeSearch

    queries.request[].cx

    string

    The identifier of an engine created using the Programmable Search Engine Control Panel . This is a custom property not defined in the OpenSearch spec. This parameter is required.

    queries.request[].sort

    string

    Specifies that results should be sorted according to the specified expression. For example, sort by date.

    queries.request[].filter

    string

    Activates or deactivates the automatic filtering of Google search results. See Automatic Filtering for more information about Google's search results filters. Valid values for this parameter are:

    • 0 : Disabled

    • 1 : Enabled (default)

    Note: By default, Google applies filtering to all search results to improve the quality of those results.

    queries.request[].gl

    string

    Boosts search results whose country of origin matches the parameter value. See Country Codes for a list of valid values.

    Specifying a gl parameter value in WebSearch requests should improve the relevance of results. This is particularly true for international customers and, even more specifically, for customers in English-speaking countries other than the United States.

    queries.request[].cr

    string

    Restricts search results to documents originating in a particular country. You may use Boolean operators in the cr parameter's value.

    Google WebSearch determines the country of a document by analyzing the following:

    • The top-level domain (TLD) of the document's URL.

    • The geographic location of the web server's IP address.

    See Country (cr) Parameter Values for a list of valid values for this parameter.

    queries.request[].googleHost

    string

    Specifies the Google domain (for example, google.com, google.de, or google.fr) to which the search should be limited.

    queries.request[].disableCnTwTranslation

    string

    Enables or disables the Simplified and Traditional Chinese Search feature.

    Supported values are:

    • 0 : enabled (default)

    • 1 : disabled

    queries.request[].hq

    string

    Appends the specified query terms to the query, as if they were combined with a logical AND operator.

    queries.request[].hl

    string

    Specifies the interface language (host language) of your user interface. Explicitly setting this parameter improves the performance and the quality of your search results.

    See the Interface Languages section of Internationalizing Queries and Results Presentation for more information, and Supported Interface Languages for a list of supported languages.

    queries.request[].siteSearch

    string

    Restricts results to URLs from a specified site.

    queries.request[].siteSearchFilter

    string

    Specifies whether to include or exclude results from the site named in the sitesearch parameter. Supported values are:

    • i : include content from site

    • e : exclude content from site

    queries.request[].exactTerms

    string

    Identifies a phrase that all documents in the search results must contain.

    queries.request[].excludeTerms

    string

    Identifies a word or phrase that should not appear in any documents in the search results.

    queries.request[].linkSite

    string

    Specifies that all results should contain a link to a specific URL.

    queries.request[].orTerms

    string

    Provides additional search terms to check for in a document, where each document in the search results must contain at least one of the additional search terms. You can also use the Boolean OR query term for this type of query.

    queries.request[].relatedSite

    string

    Specifies that all search results should be pages that are related to the specified URL. The parameter value should be a URL.

    queries.request[].dateRestrict

    string

    Restricts results to URLs based on date. Supported values include:

    • d[number] : requests results from the specified number of past days.

    • w[number] : requests results from the specified number of past weeks.

    • m[number] : requests results from the specified number of past months.

    • y[number] : requests results from the specified number of past years.

    queries.request[].lowRange

    string

    Specifies the starting value for a search range. Use cse:lowRange and cse:highrange to append an inclusive search range of lowRange...highRange to the query.

    queries.request[].highRange

    string

    Specifies the ending value for a search range. Use cse:lowRange and cse:highrange to append an inclusive search range of lowRange...highRange to the query.

    queries.request[].fileType

    string

    Restricts results to files of a specified extension. Filetypes supported by Google include:

    • Adobe Portable Document Format ( pdf )

    • Adobe PostScript ( ps )

    • Lotus 1-2-3 ( wk1 , wk2 , wk3 , wk4 , wk5 , wki , wks , wku )

    • Lotus WordPro ( lwp )

    • Macwrite ( mw )

    • Microsoft Excel ( xls )

    • Microsoft PowerPoint ( ppt )

    • Microsoft Word ( doc )

    • Microsoft Works ( wks , wps , wdb )

    • Microsoft Write ( wri )

    • Rich Text Format ( rtf )

    • Shockwave Flash ( swf )

    • Text ( ans , txt ).

    Additional filetypes may be added in the future. An up-to-date list can always be found in Google's file type FAQ .

    queries.request[].rights

    string

    Filters based on licensing. Supported values include:

    • cc_publicdomain

    • cc_attribute

    • cc_sharealike

    • cc_noncommercial

    • cc_nonderived

    queries.request[].searchType

    string

    Allowed values are web or image . If unspecified, results are limited to webpages.

    queries.request[].imgSize

    string

    Restricts results to images of a specified size. Supported values are:

    • icon (small)

    • small | medium | large | xlarge (medium)

    • xxlarge (large)

    • huge (extra-large)

    queries.request[].imgType

    string

    Restricts results to images of a specified type. Supported values are:

    • clipart (Clip art)

    • face (Face)

    • lineart (Line drawing)

    • photo (Photo)

    • animated (Animated)

    • stock (Stock)

    queries.request[].imgColorType

    string

    Restricts results to images of a specified color type. Supported values are:

    • mono (black and white)

    • gray (grayscale)

    • color (color)

    queries.request[].imgDominantColor

    string

    Restricts results to images with a specific dominant color. Supported values are:

    • red

    • orange

    • yellow

    • green

    • teal

    • blue

    • purple

    • pink

    • white

    • gray

    • black

    • brown

    queries.nextPage[]

    object

    Metadata representing the next page of results, if applicable.

    queries.nextPage[].title

    string

    A description of the query.

    queries.nextPage[].totalResults

    string ( int64 format)

    Estimated number of total search results. May not be accurate.

    queries.nextPage[].searchTerms

    string

    The search terms entered by the user.

    queries.nextPage[].count

    integer

    Number of search results returned in this set.

    queries.nextPage[].startIndex

    integer

    The index of the current set of search results into the total set of results, where the index of the first result is 1.

    queries.nextPage[].startPage

    integer

    The page number of this set of results, where the page length is set by the count property.

    queries.nextPage[].language

    string

    The language of the search results.

    queries.nextPage[].inputEncoding

    string

    The character encoding supported for search requests.

    queries.nextPage[].outputEncoding

    string

    The character encoding supported for search results.

    queries.nextPage[].safe

    string

    Specifies the SafeSearch level used for filtering out adult results. This is a custom property not defined in the OpenSearch spec. Valid parameter values are:

    • "off" : Disable SafeSearch

    • "active" : Enable SafeSearch

    queries.nextPage[].cx

    string

    The identifier of an engine created using the Programmable Search Engine Control Panel . This is a custom property not defined in the OpenSearch spec. This parameter is required.

    queries.nextPage[].sort

    string

    Specifies that results should be sorted according to the specified expression. For example, sort by date.

    queries.nextPage[].filter

    string

    Activates or deactivates the automatic filtering of Google search results. See Automatic Filtering for more information about Google's search results filters. Valid values for this parameter are:

    • 0 : Disabled

    • 1 : Enabled (default)

    Note: By default, Google applies filtering to all search results to improve the quality of those results.

    queries.nextPage[].gl

    string

    Boosts search results whose country of origin matches the parameter value. See Country Codes for a list of valid values.

    Specifying a gl parameter value in WebSearch requests should improve the relevance of results. This is particularly true for international customers and, even more specifically, for customers in English-speaking countries other than the United States.

    queries.nextPage[].cr

    string

    Restricts search results to documents originating in a particular country. You may use Boolean operators in the cr parameter's value.

    Google WebSearch determines the country of a document by analyzing the following:

    • The top-level domain (TLD) of the document's URL.

    • The geographic location of the web server's IP address.

    See Country (cr) Parameter Values for a list of valid values for this parameter.

    queries.nextPage[].googleHost

    string

    Specifies the Google domain (for example, google.com, google.de, or google.fr) to which the search should be limited.

    queries.nextPage[].disableCnTwTranslation

    string

    Enables or disables the Simplified and Traditional Chinese Search feature.

    Supported values are:

    • 0 : enabled (default)

    • 1 : disabled

    queries.nextPage[].hq

    string

    Appends the specified query terms to the query, as if they were combined with a logical AND operator.

    queries.nextPage[].hl

    string

    Specifies the interface language (host language) of your user interface. Explicitly setting this parameter improves the performance and the quality of your search results.

    See the Interface Languages section of Internationalizing Queries and Results Presentation for more information, and Supported Interface Languages for a list of supported languages.

    queries.nextPage[].siteSearch

    string

    Restricts results to URLs from a specified site.

    queries.nextPage[].siteSearchFilter

    string

    Specifies whether to include or exclude results from the site named in the sitesearch parameter. Supported values are:

    • i : include content from site

    • e : exclude content from site

    queries.nextPage[].exactTerms

    string

    Identifies a phrase that all documents in the search results must contain.

    queries.nextPage[].excludeTerms

    string

    Identifies a word or phrase that should not appear in any documents in the search results.

    queries.nextPage[].linkSite

    string

    Specifies that all results should contain a link to a specific URL.

    queries.nextPage[].orTerms

    string

    Provides additional search terms to check for in a document, where each document in the search results must contain at least one of the additional search terms. You can also use the Boolean OR query term for this type of query.

    queries.nextPage[].relatedSite

    string

    Specifies that all search results should be pages that are related to the specified URL. The parameter value should be a URL.

    queries.nextPage[].dateRestrict

    string

    Restricts results to URLs based on date. Supported values include:

    • d[number] : requests results from the specified number of past days.

    • w[number] : requests results from the specified number of past weeks.

    • m[number] : requests results from the specified number of past months.

    • y[number] : requests results from the specified number of past years.

    queries.nextPage[].lowRange

    string

    Specifies the starting value for a search range. Use cse:lowRange and cse:highrange to append an inclusive search range of lowRange...highRange to the query.

    queries.nextPage[].highRange

    string

    Specifies the ending value for a search range. Use cse:lowRange and cse:highrange to append an inclusive search range of lowRange...highRange to the query.

    queries.nextPage[].fileType

    string

    Restricts results to files of a specified extension. Filetypes supported by Google include:

    • Adobe Portable Document Format ( pdf )

    • Adobe PostScript ( ps )

    • Lotus 1-2-3 ( wk1 , wk2 , wk3 , wk4 , wk5 , wki , wks , wku )

    • Lotus WordPro ( lwp )

    • Macwrite ( mw )

    • Microsoft Excel ( xls )

    • Microsoft PowerPoint ( ppt )

    • Microsoft Word ( doc )

    • Microsoft Works ( wks , wps , wdb )

    • Microsoft Write ( wri )

    • Rich Text Format ( rtf )

    • Shockwave Flash ( swf )

    • Text ( ans , txt ).

    Additional filetypes may be added in the future. An up-to-date list can always be found in Google's file type FAQ .

    queries.nextPage[].rights

    string

    Filters based on licensing. Supported values include:

    • cc_publicdomain

    • cc_attribute

    • cc_sharealike

    • cc_noncommercial

    • cc_nonderived

    queries.nextPage[].searchType

    string

    Allowed values are web or image . If unspecified, results are limited to webpages.

    queries.nextPage[].imgSize

    string

    Restricts results to images of a specified size. Supported values are:

    • icon (small)

    • small | medium | large | xlarge (medium)

    • xxlarge (large)

    • huge (extra-large)

    queries.nextPage[].imgType

    string

    Restricts results to images of a specified type. Supported values are:

    • clipart (Clip art)

    • face (Face)

    • lineart (Line drawing)

    • photo (Photo)

    • animated (Animated)

    • stock (Stock)

    queries.nextPage[].imgColorType

    string

    Restricts results to images of a specified color type. Supported values are:

    • mono (black and white)

    • gray (grayscale)

    • color (color)

    queries.nextPage[].imgDominantColor

    string

    Restricts results to images with a specific dominant color. Supported values are:

    • red

    • orange

    • yellow

    • green

    • teal

    • blue

    • purple

    • pink

    • white

    • gray

    • black

    • brown

    promotions[]

    object ( Promotion )

    The set of promotions . Present only if the custom search engine's configuration files define any promotions for the given query.

    context

    object ( Struct format)

    Metadata and refinements associated with the given search engine, including:

    • The name of the search engine that was used for the query.

    • A set of facet objects (refinements) you can use for refining a search.

    searchInformation

    object

    Metadata about about this search, including search time and total results.

    searchInformation.searchTime

    number

    The time taken for the server to return search results.

    searchInformation.formattedSearchTime

    string

    The time taken for the server to return search results, formatted according to locale style.

    searchInformation.totalResults

    string

    The total number of search results returned by the query.

    searchInformation.formattedTotalResults

    string

    The total number of search results, formatted according to locale style.

    spelling

    object

    Encapsulates a corrected query.

    spelling.correctedQuery

    string

    The corrected query.

    spelling.htmlCorrectedQuery

    string

    The corrected query, formatted in HTML.

    items[]

    object ( Result )

    The current set of custom search results.

    Promotion

    Promotion result.

    JSON representation 
     { 
 "title" 
 : 
 string 
 , 
 "htmlTitle" 
 : 
 string 
 , 
 "link" 
 : 
 string 
 , 
 "displayLink" 
 : 
 string 
 , 
 "bodyLines" 
 : 
 [ 
 { 
 "title" 
 : 
 string 
 , 
 "htmlTitle" 
 : 
 string 
 , 
 "url" 
 : 
 string 
 , 
 "link" 
 : 
 string 
 } 
 ] 
 , 
 "image" 
 : 
 { 
 "source" 
 : 
 string 
 , 
 "width" 
 : 
 integer 
 , 
 "height" 
 : 
 integer 
 } 
 }
    Fields
    title

    string

    The title of the promotion.
    htmlTitle

    string

    The title of the promotion, in HTML.
    bodyLines[]

    object

    An array of block objects for this promotion.
    bodyLines[].title

    string

    The block object's text, if it has text.
    bodyLines[].htmlTitle

    string

    The block object's text in HTML, if it has text.
    bodyLines[].url

    string

    The URL of the block object's link, if it has one.
    bodyLines[].link

    string

    The anchor text of the block object's link, if it has a link.
    image

    object

    Image associated with this promotion, if there is one.
    image.source

    string

    URL of the image for this promotion link.
    image.width

    integer

    Image width in pixels.
    image.height

    integer

    Image height in pixels.

    Result

    A custom search result.

    JSON representation 
     { 
 "kind" 
 : 
 string 
 , 
 "title" 
 : 
 string 
 , 
 "htmlTitle" 
 : 
 string 
 , 
 "link" 
 : 
 string 
 , 
 "displayLink" 
 : 
 string 
 , 
 "snippet" 
 : 
 string 
 , 
 "htmlSnippet" 
 : 
 string 
 , 
 "cacheId" 
 : 
 string 
 , 
 "formattedUrl" 
 : 
 string 
 , 
 "htmlFormattedUrl" 
 : 
 string 
 , 
 "pagemap" 
 : 
 { 
 object 
 } 
 , 
 "mime" 
 : 
 string 
 , 
 "fileFormat" 
 : 
 string 
 , 
 "image" 
 : 
 { 
 "contextLink" 
 : 
 string 
 , 
 "height" 
 : 
 integer 
 , 
 "width" 
 : 
 integer 
 , 
 "byteSize" 
 : 
 integer 
 , 
 "thumbnailLink" 
 : 
 string 
 , 
 "thumbnailHeight" 
 : 
 integer 
 , 
 "thumbnailWidth" 
 : 
 integer 
 } 
 , 
 "labels" 
 : 
 [ 
 { 
 "name" 
 : 
 string 
 , 
 "displayName" 
 : 
 string 
 , 
 "label_with_op" 
 : 
 string 
 } 
 ] 
 }
    Fields
    kind

    string

    A unique identifier for the type of current object. For this API, it is customsearch#result.

    title

    string

    The title of the search result, in plain text.
    htmlTitle

    string

    The title of the search result, in HTML.
    snippet

    string

    The snippet of the search result, in plain text.
    htmlSnippet

    string

    The snippet of the search result, in HTML.
    cacheId

    string

    Indicates the ID of Google's cached version of the search result.
    formattedUrl

    string

    The URL displayed after the snippet for each search result.
    htmlFormattedUrl

    string

    The HTML-formatted URL displayed after the snippet for each search result.
    pagemap

    object ( Struct format)

    Contains PageMap information for this search result.
    mime

    string

    The MIME type of the search result.
    fileFormat

    string

    The file format of the search result.
    image

    object

    Encapsulates all information about an image returned in search results.
    image.contextLink

    string

    A URL pointing to the webpage hosting the image.
    image.height

    integer

    The height of the image, in pixels.
    image.width

    integer

    The width of the image, in pixels.
    image.byteSize

    integer

    The size of the image, in bytes.
    image.thumbnailLink

    string

    A URL to the thumbnail image.
    image.thumbnailHeight

    integer

    The height of the thumbnail image, in pixels.
    image.thumbnailWidth

    integer

    The width of the thumbnail image, in pixels.
    labels[]

    object

    Encapsulates all information about refinement labels.
    labels[].name

    string

    The name of a refinement label, which you can use to refine searches. Don't display this in your user interface; instead, use displayName.
    labels[].displayName

    string

    The display name of a refinement label. This is the name you should display in your user interface.
    labels[].label_with_op

    string

    Refinement label and the associated refinement operation.
    Design a Mobile Site
    View Site in Mobile | Classic
    Share by: