Blame - docs/dyn/customsearch_v1.cse.html - platform/external/python/google-api-python-client

2020-05-20 12:08:20 -0700

[diff] [blame]

84

<p class="firstline">Returns metadata about the search performed, metadata about the custom</p>

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

85

<h3>Method Details</h3>

86

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

87

<code class="details" id="list">list(imgDominantColor=None, relatedSite=None, linkSite=None, excludeTerms=None, searchType=None, highRange=None, rights=None, dateRestrict=None, filter=None, hl=None, imgType=None, googlehost=None, siteSearch=None, siteSearchFilter=None, imgSize=None, lowRange=None, exactTerms=None, num=None, sort=None, orTerms=None, gl=None, imgColorType=None, safe=None, cr=None, hq=None, start=None, c2coff=None, lr=None, fileType=None, q=None, cx=None, x__xgafv=None)</code>

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

88

<pre>Returns metadata about the search performed, metadata about the custom

89

search engine used for the search, and the search results.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

90

91

Args:

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

92

imgDominantColor: string, Returns images of a specific dominant color. Acceptable values are:

* `"black"`

* `"blue"`

* `"brown"`

* `"gray"`

* `"green"`

* `"orange"`

* `"pink"`

* `"purple"`

* `"red"`

* `"teal"`

* `"white"`

* `"yellow"`

relatedSite: string, Specifies that all search results should be pages that are related to the

118

specified URL.

119

linkSite: string, Specifies that all search results should contain a link to a particular

120

URL.

121

excludeTerms: string, Identifies a word or phrase that should not appear in any documents in the

122

search results.

123

searchType: string, Specifies the search type: `image`. If unspecified, results are limited to

124

webpages.

125

126

Acceptable values are:

127

128

* `"image"`: custom image search.

129

highRange: string, Specifies the ending value for a search range.

130

131

* Use `lowRange` and `highRange` to append an inclusive search range of

132

`lowRange...highRange` to the query.

133

rights: string, Filters based on licensing. Supported values include: `cc_publicdomain`,

134

`cc_attribute`, `cc_sharealike`, `cc_noncommercial`, `cc_nonderived` and

135

combinations of these. See [typical

136

combinations](https://wiki.creativecommons.org/wiki/CC_Search_integration).

137

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

138

139

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

140

141

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

142

143

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

144

145

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

146

filter: string, Controls turning on or off the duplicate content filter.

147

148

* See [Automatic

149

Filtering](https://developers.google.com/custom-search/docs/xml_results#automaticFiltering)

150

for more information about Google's search results filters. Note that host

151

crowding filtering applies only to multi-site searches.

152

153

* By default, Google applies filtering to all search results to improve the

154

quality of those results.

155

156

Acceptable values are:

157

158

* `0`: Turns off duplicate content filter.

159

160

* `1`: Turns on duplicate content filter.

161

hl: string, Sets the user interface language.

162

163

* Explicitly setting this parameter improves the performance and the

164

quality of your search results.

165

166

* See the [Interface

167

Languages](https://developers.google.com/custom-search/docs/xml_results#wsInterfaceLanguages)

168

section of [Internationalizing Queries and Results

169

Presentation](https://developers.google.com/custom-search/docs/xml_results#wsInternationalizing)

170

for more information, and (Supported Interface

171

Languages)[https://developers.google.com/custom-search/docs/xml_results_appendices#interfaceLanguages]

172

for a list of supported languages.

173

imgType: string, Returns images of a type. Acceptable values are:

* `"clipart"`

* `"face"`

* `"lineart"`

* `"stock"`

* `"photo"`

* `"animated"`

googlehost: string, **Deprecated**. Use the `gl` parameter for a similar effect.

187

188

The local Google domain (for example, google.com, google.de, or

189

google.fr) to use to perform the search.

190

siteSearch: string, Specifies a given site which should always be included or excluded from

191

results (see `siteSearchFilter` parameter, below).

192

siteSearchFilter: string, Controls whether to include or exclude results from the site named in the

193

`siteSearch` parameter.

194

195

Acceptable values are:

* `"e"`: exclude

* `"i"`: include

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

200

imgSize: string, Returns images of a specified size. Acceptable values are:

* `"huge"`

* `"icon"`

* `"large"`

* `"medium"`

* `"small"`

* `"xlarge"`

* `"xxlarge"`

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

215

lowRange: string, Specifies the starting value for a search range. Use `lowRange` and

216

`highRange` to append an inclusive search range of `lowRange...highRange`

217

to the query.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

218

exactTerms: string, Identifies a phrase that all documents in the search results must contain.

219

num: integer, Number of search results to return.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

220

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

221

* Valid values are integers between 1 and 10, inclusive.

222

sort: string, The sort expression to apply to the results.

223

orTerms: string, Provides additional search terms to check for in a document, where each

224

document in the search results must contain at least one of the additional

225

search terms.

226

gl: string, Geolocation of end user.

227

228

* The `gl` parameter value is a two-letter country code. The `gl` parameter

229

boosts search results whose country of origin matches the parameter value.

230

See the [Country

231

Codes](https://developers.google.com/custom-search/docs/xml_results_appendices#countryCodes)

232

page for a list of valid values.

233

234

* Specifying a `gl` parameter value should lead to more relevant results.

235

This is particularly true for international customers and, even more

236

specifically, for customers in English- speaking countries other than the

237

United States.

238

imgColorType: string, Returns black and white, grayscale, transparent, or color images.

239

Acceptable values are:

* `"color"`

* `"gray"`

* `"mono"`: black and white

246

247

* `"trans"`: transparent background

248

safe: string, Search safety level. Acceptable values are:

249

250

* `"active"`: Enables SafeSearch filtering.

251

252

* `"off"`: Disables SafeSearch filtering. (default)

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

253

cr: string, Restricts search results to documents originating in a particular country.

254

You may use [Boolean

255

operators](https://developers.google.com/custom-search/docs/xml_results_appendices#booleanOperators)

256

in the cr parameter's value.

257

258

Google Search determines the country of a document by analyzing:

259

260

* the top-level domain (TLD) of the document's URL

261

262

* the geographic location of the Web server's IP address

263

264

See the [Country Parameter

265

Values](https://developers.google.com/custom-search/docs/xml_results_appendices#countryCollections)

266

page for a list of valid values for this parameter.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

267

hq: string, Appends the specified query terms to the query, as if they were combined

268

with a logical AND operator.

269

start: integer, The index of the first result to return. The default number of results per

270

page is 10, so `&start=11` would start at the top of the second page of

271

results. **Note**: The JSON API will never return more than 100 results,

272

even if more than 100 documents match the query, so setting the sum of

273

`start + num` to a number greater than 100 will produce an error. Also note

274

that the maximum value for `num` is 10.

275

c2coff: string, Enables or disables [Simplified and Traditional Chinese

276

Search](https://developers.google.com/custom-search/docs/xml_results#chineseSearch).

277

278

The default value for this parameter is 0 (zero), meaning that the feature

279

is enabled. Supported values are:

* `1`: Disabled

* `0`: Enabled (default)

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

284

lr: string, Restricts the search to documents written in a particular language (e.g.,

285

`lr=lang_ja`).

286

287

Acceptable values are:

288

289

* `"lang_ar"`: Arabic

290

291

* `"lang_bg"`: Bulgarian

292

293

* `"lang_ca"`: Catalan

* `"lang_cs"`: Czech

* `"lang_da"`: Danish

298

299

* `"lang_de"`: German

* `"lang_el"`: Greek

* `"lang_en"`: English

304

305

* `"lang_es"`: Spanish

306

307

* `"lang_et"`: Estonian

308

309

* `"lang_fi"`: Finnish

310

311

* `"lang_fr"`: French

312

313

* `"lang_hr"`: Croatian

314

315

* `"lang_hu"`: Hungarian

316

317

* `"lang_id"`: Indonesian

318

319

* `"lang_is"`: Icelandic

320

321

* `"lang_it"`: Italian

322

323

* `"lang_iw"`: Hebrew

324

325

* `"lang_ja"`: Japanese

326

327

* `"lang_ko"`: Korean

328

329

* `"lang_lt"`: Lithuanian

330

331

* `"lang_lv"`: Latvian

* `"lang_nl"`: Dutch

* `"lang_no"`: Norwegian

336

337

* `"lang_pl"`: Polish

338

339

* `"lang_pt"`: Portuguese

340

341

* `"lang_ro"`: Romanian

342

343

* `"lang_ru"`: Russian

344

345

* `"lang_sk"`: Slovak

346

347

* `"lang_sl"`: Slovenian

348

349

* `"lang_sr"`: Serbian

350

351

* `"lang_sv"`: Swedish

352

353

* `"lang_tr"`: Turkish

354

355

* `"lang_zh-CN"`: Chinese (Simplified)

356

357

* `"lang_zh-TW"`: Chinese (Traditional)

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

358

fileType: string, Restricts results to files of a specified extension. A list of file types

359

indexable by Google can be found in Search Console [Help

360

Center](https://support.google.com/webmasters/answer/35287).

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

361

q: string, Query

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

362

cx: string, The custom search engine ID to use for this request.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

363

x__xgafv: string, V1 error format.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

364

Allowed values

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

365

1 - v1 error format

366

2 - v2 error format

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

367

368

Returns:

369

An object of the form:

370

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

371

{ # Response to a custom search request.

372

"queries": { # Query metadata for the previous, current, and next pages of results.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

373

"request": [ # Metadata representing the current request.

374

{ # Custom search request metadata.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

375

"language": "A String", # The language of the search results.

376

"googleHost": "A String", # Specifies the Google domain (for example, google.com, google.de, or

377

# google.fr) to which the search should be limited.

378

"imgSize": "A String", # Restricts results to images of a specified size. Supported values are:

#

# * `icon` (small)

#

# * `small | medium | large | xlarge` (medium)

383

#

384

# * `xxlarge` (large)

385

#

386

# * `huge` (extra-large)

387

"filter": "A String", # Activates or deactivates the automatic filtering of Google search

388

# results. See [Automatic

389

# Filtering](https://developers.google.com/custom-search/docs/xml_results#automaticFiltering)

390

# for more information about Google's search results filters. Valid values

391

# for this parameter are:

#

# * `0`: Disabled

#

# * `1`: Enabled (default)

396

#

397

# **Note**: By default, Google applies filtering to all search results to

398

# improve the quality of those results.

399

"imgDominantColor": "A 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`

"title": "A String", # A description of the query.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

426

"disableCnTwTranslation": "A String", # Enables or disables the [Simplified and Traditional Chinese

427

# Search](https://developers.google.com/custom-search/docs/xml_results#chineseSearch)

428

# feature.

429

#

430

# Supported values are:

431

#

432

# * `0`: enabled (default)

433

#

434

# * `1`: disabled

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

435

"sort": "A String", # Specifies that results should be sorted according to the specified

436

# expression. For example, sort by date.

437

"startPage": 42, # The page number of this set of results, where the page length is set by

438

# the `count` property.

439

"inputEncoding": "A String", # The character encoding supported for search requests.

440

"cx": "A String", # The identifier of a custom search engine created using the Custom Search

441

# [Control Panel](https://cse.google.com/). This is a custom property not

442

# defined in the OpenSearch spec. This parameter is **required**.

443

"gl": "A String", # Boosts search results whose country of origin matches the parameter

444

# value. See [Country

445

# Codes](https://developers.google.com/custom-search/docs/xml_results#countryCodes)

446

# for a list of valid values.

447

#

448

# Specifying a `gl` parameter value in WebSearch requests should improve

449

# the relevance of results. This is particularly true for international

450

# customers and, even more specifically, for customers in English-speaking

451

# countries other than the United States.

452

"excludeTerms": "A String", # Identifies a word or phrase that should not appear in any documents in

453

# the search results.

454

"outputEncoding": "A String", # The character encoding supported for search results.

455

"searchTerms": "A String", # The search terms entered by the user.

456

"highRange": "A String", # Specifies the ending value for a search range. Use `cse:lowRange` and

457

# `cse:highrange` to append an inclusive search range of

458

# `lowRange...highRange` to the query.

459

"siteSearch": "A String", # Restricts results to URLs from a specified site.

460

"hq": "A String", # Appends the specified query terms to the query, as if they were combined

461

# with a logical `AND` operator.

462

"count": 42, # Number of search results returned in this set.

463

"relatedSite": "A String", # Specifies that all search results should be pages that are related to the

464

# specified URL. The parameter value should be a URL.

465

"hl": "A String", # Specifies the interface language (host language) of your user interface.

466

# Explicitly setting this parameter improves the performance and the

467

# quality of your search results.

468

#

469

# See the [Interface

470

# Languages](https://developers.google.com/custom-search/docs/xml_results#wsInterfaceLanguages)

471

# section of [Internationalizing Queries and Results

472

# Presentation](https://developers.google.com/custom-search/docs/xml_results#wsInternationalizing)

473

# for more information, and [Supported Interface

474

# Languages](https://developers.google.com/custom-search/docs/xml_results_appendices#interfaceLanguages)

475

# for a list of supported languages.

476

"totalResults": "A String", # Estimated number of total search results. May not be accurate.

477

"rights": "A String", # Filters based on licensing. Supported values include:

478

#

479

# * `cc_publicdomain`

#

# * `cc_attribute`

#

# * `cc_sharealike`

#

# * `cc_noncommercial`

486

#

487

# * `cc_nonderived`

488

"cr": "A String", # Restricts search results to documents originating in a particular

489

# country. You may use [Boolean

490

# operators](https://developers.google.com/custom-search/docs/xml_results#booleanOperators)

491

# in the `cr` parameter's value.

492

#

493

# Google WebSearch determines the country of a document by analyzing the

494

# following:

495

#

496

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

497

#

498

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

499

#

500

# See [Country (cr) Parameter

501

# Values](https://developers.google.com/custom-search/docs/xml_results#countryCollections)

502

# for a list of valid values for this parameter.

503

"imgColorType": "A String", # Restricts results to images of a specified color type. Supported values

504

# are:

505

#

506

# * `mono` (black and white)

507

#

508

# * `gray` (grayscale)

509

#

510

# * `color` (color)

511

"safe": "A String", # Specifies the [SafeSearch

512

# level](https://developers.google.com/custom-search/docs/xml_results#safeSearchLevels)

513

# used for filtering out adult results. This is a custom property not

514

# defined in the OpenSearch spec. Valid parameter values are:

515

#

516

# * `"off"`: Disable SafeSearch

517

#

518

# * `"active"`: Enable SafeSearch

519

"dateRestrict": "A String", # Restricts results to URLs based on date. Supported values include:

520

#

521

# * `d[number]`: requests results from the specified number of past days.

522

#

523

# * `w[number]`: requests results from the specified number of past weeks.

524

#

525

# * `m[number]`: requests results from the specified number of past months.

526

#

527

# * `y[number]`: requests results from the specified number of past years.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

528

"fileType": "A String", # Restricts results to files of a specified extension. Filetypes supported

529

# by Google include:

530

#

531

# * Adobe Portable Document Format (`pdf`)

532

#

533

# * Adobe PostScript (`ps`)

534

#

535

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

536

#

537

# * Lotus WordPro (`lwp`)

#

# * Macwrite (`mw`)

#

# * Microsoft Excel (`xls`)

542

#

543

# * Microsoft PowerPoint (`ppt`)

544

#

545

# * Microsoft Word (`doc`)

546

#

547

# * Microsoft Works (`wks`, `wps`, `wdb`)

548

#

549

# * Microsoft Write (`wri`)

550

#

551

# * Rich Text Format (`rtf`)

552

#

553

# * Shockwave Flash (`swf`)

554

#

555

# * Text (`ans`, `txt`).

556

#

557

# Additional filetypes may be added in the future. An up-to-date list can

558

# always be found in Google's [file type

559

# FAQ](https://support.google.com/webmasters/answer/35287).

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

560

"searchType": "A String", # Allowed values are `web` or `image`. If unspecified, results are limited

561

# to webpages.

562

"imgType": "A String", # Restricts results to images of a specified type. Supported values are:

563

#

564

# * `clipart` (Clip art)

#

# * `face` (Face)

#

# * `lineart` (Line drawing)

#

# * `photo` (Photo)

#

# * `animated` (Animated)

573

#

574

# * `stock` (Stock)

575

"linkSite": "A String", # Specifies that all results should contain a link to a specific URL.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

576

"siteSearchFilter": "A String", # Specifies whether to include or exclude results from the site named in

577

# the `sitesearch` parameter. Supported values are:

578

#

579

# * `i`: include content from site

580

#

581

# * `e`: exclude content from site

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

582

"startIndex": 42, # The index of the current set of search results into the total set of

583

# results, where the index of the first result is 1.

584

"lowRange": "A String", # Specifies the starting value for a search range. Use `cse:lowRange` and

585

# `cse:highrange` to append an inclusive search range of

586

# `lowRange...highRange` to the query.

587

"exactTerms": "A String", # Identifies a phrase that all documents in the search results must

588

# contain.

589

"orTerms": "A String", # Provides additional search terms to check for in a document, where each

590

# document in the search results must contain at least one of the

591

# additional search terms. You can also use the [Boolean

592

# OR](https://developers.google.com/custom-search/docs/xml_results#BooleanOrqt)

593

# query term for this type of query.

594

},

595

],

596

"nextPage": [ # Metadata representing the next page of results, if applicable.

597

{ # Custom search request metadata.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

598

"gl": "A String", # Boosts search results whose country of origin matches the parameter

599

# value. See [Country

600

# Codes](https://developers.google.com/custom-search/docs/xml_results#countryCodes)

601

# for a list of valid values.

602

#

603

# Specifying a `gl` parameter value in WebSearch requests should improve

604

# the relevance of results. This is particularly true for international

605

# customers and, even more specifically, for customers in English-speaking

606

# countries other than the United States.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

607

"safe": "A String", # Specifies the [SafeSearch

608

# level](https://developers.google.com/custom-search/docs/xml_results#safeSearchLevels)

609

# used for filtering out adult results. This is a custom property not

610

# defined in the OpenSearch spec. Valid parameter values are:

611

#

612

# * `"off"`: Disable SafeSearch

613

#

614

# * `"active"`: Enable SafeSearch

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

615

"language": "A String", # The language of the search results.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

616

"hl": "A String", # Specifies the interface language (host language) of your user interface.

617

# Explicitly setting this parameter improves the performance and the

618

# quality of your search results.

619

#

620

# See the [Interface

621

# Languages](https://developers.google.com/custom-search/docs/xml_results#wsInterfaceLanguages)

622

# section of [Internationalizing Queries and Results

623

# Presentation](https://developers.google.com/custom-search/docs/xml_results#wsInternationalizing)

624

# for more information, and [Supported Interface

625

# Languages](https://developers.google.com/custom-search/docs/xml_results_appendices#interfaceLanguages)

626

# for a list of supported languages.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

627

"excludeTerms": "A String", # Identifies a word or phrase that should not appear in any documents in

628

# the search results.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

629

"filter": "A String", # Activates or deactivates the automatic filtering of Google search

630

# results. See [Automatic

631

# Filtering](https://developers.google.com/custom-search/docs/xml_results#automaticFiltering)

632

# for more information about Google's search results filters. Valid values

633

# for this parameter are:

#

# * `0`: Disabled

#

# * `1`: Enabled (default)

638

#

639

# **Note**: By default, Google applies filtering to all search results to

640

# improve the quality of those results.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

641

"title": "A String", # A description of the query.

642

"dateRestrict": "A String", # Restricts results to URLs based on date. Supported values include:

643

#

644

# * `d[number]`: requests results from the specified number of past days.

645

#

646

# * `w[number]`: requests results from the specified number of past weeks.

647

#

648

# * `m[number]`: requests results from the specified number of past months.

649

#

650

# * `y[number]`: requests results from the specified number of past years.

651

"highRange": "A String", # Specifies the ending value for a search range. Use `cse:lowRange` and

652

# `cse:highrange` to append an inclusive search range of

653

# `lowRange...highRange` to the query.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

654

"sort": "A String", # Specifies that results should be sorted according to the specified

655

# expression. For example, sort by date.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

656

"relatedSite": "A String", # Specifies that all search results should be pages that are related to the

657

# specified URL. The parameter value should be a URL.

658

"orTerms": "A String", # Provides additional search terms to check for in a document, where each

659

# document in the search results must contain at least one of the

660

# additional search terms. You can also use the [Boolean

661

# OR](https://developers.google.com/custom-search/docs/xml_results#BooleanOrqt)

662

# query term for this type of query.

663

"searchTerms": "A String", # The search terms entered by the user.

664

"outputEncoding": "A String", # The character encoding supported for search results.

665

"imgType": "A String", # Restricts results to images of a specified type. Supported values are:

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

666

#

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

667

# * `clipart` (Clip art)

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

668

#

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

669

# * `face` (Face)

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

670

#

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

671

# * `lineart` (Line drawing)

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

672

#

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

673

# * `photo` (Photo)

674

#

675

# * `animated` (Animated)

676

#

677

# * `stock` (Stock)

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

678

"imgDominantColor": "A 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`

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

704

"hq": "A String", # Appends the specified query terms to the query, as if they were combined

705

# with a logical `AND` operator.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

706

"count": 42, # Number of search results returned in this set.

707

"startPage": 42, # The page number of this set of results, where the page length is set by

708

# the `count` property.

709

"startIndex": 42, # The index of the current set of search results into the total set of

710

# results, where the index of the first result is 1.

711

"cx": "A String", # The identifier of a custom search engine created using the Custom Search

712

# [Control Panel](https://cse.google.com/). This is a custom property not

713

# defined in the OpenSearch spec. This parameter is **required**.

714

"exactTerms": "A String", # Identifies a phrase that all documents in the search results must

715

# contain.

716

"linkSite": "A String", # Specifies that all results should contain a link to a specific URL.

717

"imgColorType": "A String", # Restricts results to images of a specified color type. Supported values

718

# are:

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

719

#

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

720

# * `mono` (black and white)

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

721

#

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

722

# * `gray` (grayscale)

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

723

#

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

724

# * `color` (color)

725

"siteSearchFilter": "A String", # Specifies whether to include or exclude results from the site named in

726

# the `sitesearch` parameter. Supported values are:

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

727

#

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

728

# * `i`: include content from site

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

729

#

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

730

# * `e`: exclude content from site

731

"inputEncoding": "A String", # The character encoding supported for search requests.

732

"cr": "A String", # Restricts search results to documents originating in a particular

733

# country. You may use [Boolean

734

# operators](https://developers.google.com/custom-search/docs/xml_results#booleanOperators)

735

# in the `cr` parameter's value.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

736

#

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

737

# Google WebSearch determines the country of a document by analyzing the

738

# following:

739

#

740

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

741

#

742

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

743

#

744

# See [Country (cr) Parameter

745

# Values](https://developers.google.com/custom-search/docs/xml_results#countryCollections)

746

# for a list of valid values for this parameter.

747

"rights": "A String", # Filters based on licensing. Supported values include:

748

#

749

# * `cc_publicdomain`

#

# * `cc_attribute`

#

# * `cc_sharealike`

#

# * `cc_noncommercial`

756

#

757

# * `cc_nonderived`

758

"imgSize": "A String", # Restricts results to images of a specified size. Supported values are:

#

# * `icon` (small)

#

# * `small | medium | large | xlarge` (medium)

763

#

764

# * `xxlarge` (large)

765

#

766

# * `huge` (extra-large)

767

"siteSearch": "A String", # Restricts results to URLs from a specified site.

768

"disableCnTwTranslation": "A String", # Enables or disables the [Simplified and Traditional Chinese

769

# Search](https://developers.google.com/custom-search/docs/xml_results#chineseSearch)

770

# feature.

771

#

772

# Supported values are:

773

#

774

# * `0`: enabled (default)

775

#

776

# * `1`: disabled

777

"searchType": "A String", # Allowed values are `web` or `image`. If unspecified, results are limited

778

# to webpages.

779

"lowRange": "A String", # Specifies the starting value for a search range. Use `cse:lowRange` and

780

# `cse:highrange` to append an inclusive search range of

781

# `lowRange...highRange` to the query.

782

"googleHost": "A String", # Specifies the Google domain (for example, google.com, google.de, or

783

# google.fr) to which the search should be limited.

784

"fileType": "A String", # Restricts results to files of a specified extension. Filetypes supported

785

# by Google include:

786

#

787

# * Adobe Portable Document Format (`pdf`)

788

#

789

# * Adobe PostScript (`ps`)

790

#

791

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

792

#

793

# * Lotus WordPro (`lwp`)

#

# * Macwrite (`mw`)

#

# * Microsoft Excel (`xls`)

798

#

799

# * Microsoft PowerPoint (`ppt`)

800

#

801

# * Microsoft Word (`doc`)

802

#

803

# * Microsoft Works (`wks`, `wps`, `wdb`)

804

#

805

# * Microsoft Write (`wri`)

806

#

807

# * Rich Text Format (`rtf`)

808

#

809

# * Shockwave Flash (`swf`)

810

#

811

# * Text (`ans`, `txt`).

812

#

813

# Additional filetypes may be added in the future. An up-to-date list can

814

# always be found in Google's [file type

815

# FAQ](https://support.google.com/webmasters/answer/35287).

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

816

"totalResults": "A String", # Estimated number of total search results. May not be accurate.

817

},

818

],

819

"previousPage": [ # Metadata representing the previous page of results, if applicable.

820

{ # Custom search request metadata.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

821

"safe": "A String", # Specifies the [SafeSearch

822

# level](https://developers.google.com/custom-search/docs/xml_results#safeSearchLevels)

823

# used for filtering out adult results. This is a custom property not

824

# defined in the OpenSearch spec. Valid parameter values are:

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

825

#

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

826

# * `"off"`: Disable SafeSearch

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

827

#

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

828

# * `"active"`: Enable SafeSearch

829

"rights": "A String", # Filters based on licensing. Supported values include:

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

830

#

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

831

# * `cc_publicdomain`

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

832

#

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

833

# * `cc_attribute`

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

834

#

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

835

# * `cc_sharealike`

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

836

#

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

837

# * `cc_noncommercial`

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

838

#

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

839

# * `cc_nonderived`

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

840

"googleHost": "A String", # Specifies the Google domain (for example, google.com, google.de, or

841

# google.fr) to which the search should be limited.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

842

"sort": "A String", # Specifies that results should be sorted according to the specified

843

# expression. For example, sort by date.

844

"orTerms": "A String", # Provides additional search terms to check for in a document, where each

845

# document in the search results must contain at least one of the

846

# additional search terms. You can also use the [Boolean

847

# OR](https://developers.google.com/custom-search/docs/xml_results#BooleanOrqt)

848

# query term for this type of query.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

849

"startIndex": 42, # The index of the current set of search results into the total set of

850

# results, where the index of the first result is 1.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

851

"startPage": 42, # The page number of this set of results, where the page length is set by

852

# the `count` property.

853

"searchType": "A String", # Allowed values are `web` or `image`. If unspecified, results are limited

854

# to webpages.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

855

"fileType": "A String", # Restricts results to files of a specified extension. Filetypes supported

856

# by Google include:

857

#

858

# * Adobe Portable Document Format (`pdf`)

859

#

860

# * Adobe PostScript (`ps`)

861

#

862

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

863

#

864

# * Lotus WordPro (`lwp`)

#

# * Macwrite (`mw`)

#

# * Microsoft Excel (`xls`)

869

#

870

# * Microsoft PowerPoint (`ppt`)

871

#

872

# * Microsoft Word (`doc`)

873

#

874

# * Microsoft Works (`wks`, `wps`, `wdb`)

875

#

876

# * Microsoft Write (`wri`)

877

#

878

# * Rich Text Format (`rtf`)

879

#

880

# * Shockwave Flash (`swf`)

881

#

882

# * Text (`ans`, `txt`).

883

#

884

# Additional filetypes may be added in the future. An up-to-date list can

885

# always be found in Google's [file type

886

# FAQ](https://support.google.com/webmasters/answer/35287).

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

887

"imgSize": "A String", # Restricts results to images of a specified size. Supported values are:

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

888

#

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

889

# * `icon` (small)

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

890

#

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

891

# * `small | medium | large | xlarge` (medium)

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

892

#

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

893

# * `xxlarge` (large)

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

894

#

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

895

# * `huge` (extra-large)

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

896

"cr": "A String", # Restricts search results to documents originating in a particular

897

# country. You may use [Boolean

898

# operators](https://developers.google.com/custom-search/docs/xml_results#booleanOperators)

899

# in the `cr` parameter's value.

900

#

901

# Google WebSearch determines the country of a document by analyzing the

902

# following:

903

#

904

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

905

#

906

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

907

#

908

# See [Country (cr) Parameter

909

# Values](https://developers.google.com/custom-search/docs/xml_results#countryCollections)

910

# for a list of valid values for this parameter.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

911

"disableCnTwTranslation": "A String", # Enables or disables the [Simplified and Traditional Chinese

912

# Search](https://developers.google.com/custom-search/docs/xml_results#chineseSearch)

913

# feature.

914

#

915

# Supported values are:

916

#

917

# * `0`: enabled (default)

918

#

919

# * `1`: disabled

920

"imgColorType": "A String", # Restricts results to images of a specified color type. Supported values

921

# are:

922

#

923

# * `mono` (black and white)

924

#

925

# * `gray` (grayscale)

926

#

927

# * `color` (color)

928

"highRange": "A String", # Specifies the ending value for a search range. Use `cse:lowRange` and

929

# `cse:highrange` to append an inclusive search range of

930

# `lowRange...highRange` to the query.

931

"excludeTerms": "A String", # Identifies a word or phrase that should not appear in any documents in

932

# the search results.

933

"count": 42, # Number of search results returned in this set.

934

"title": "A String", # A description of the query.

935

"searchTerms": "A String", # The search terms entered by the user.

936

"filter": "A String", # Activates or deactivates the automatic filtering of Google search

937

# results. See [Automatic

938

# Filtering](https://developers.google.com/custom-search/docs/xml_results#automaticFiltering)

939

# for more information about Google's search results filters. Valid values

940

# for this parameter are:

#

# * `0`: Disabled

#

# * `1`: Enabled (default)

945

#

946

# **Note**: By default, Google applies filtering to all search results to

947

# improve the quality of those results.

948

"language": "A String", # The language of the search results.

949

"lowRange": "A String", # Specifies the starting value for a search range. Use `cse:lowRange` and

950

# `cse:highrange` to append an inclusive search range of

951

# `lowRange...highRange` to the query.

952

"imgType": "A String", # Restricts results to images of a specified type. Supported values are:

953

#

954

# * `clipart` (Clip art)

#

# * `face` (Face)

#

# * `lineart` (Line drawing)

#

# * `photo` (Photo)

#

# * `animated` (Animated)

963

#

964

# * `stock` (Stock)

965

"hl": "A String", # Specifies the interface language (host language) of your user interface.

966

# Explicitly setting this parameter improves the performance and the

967

# quality of your search results.

968

#

969

# See the [Interface

970

# Languages](https://developers.google.com/custom-search/docs/xml_results#wsInterfaceLanguages)

971

# section of [Internationalizing Queries and Results

972

# Presentation](https://developers.google.com/custom-search/docs/xml_results#wsInternationalizing)

973

# for more information, and [Supported Interface

974

# Languages](https://developers.google.com/custom-search/docs/xml_results_appendices#interfaceLanguages)

975

# for a list of supported languages.

976

"outputEncoding": "A String", # The character encoding supported for search results.

977

"gl": "A String", # Boosts search results whose country of origin matches the parameter

978

# value. See [Country

979

# Codes](https://developers.google.com/custom-search/docs/xml_results#countryCodes)

980

# for a list of valid values.

981

#

982

# Specifying a `gl` parameter value in WebSearch requests should improve

983

# the relevance of results. This is particularly true for international

984

# customers and, even more specifically, for customers in English-speaking

985

# countries other than the United States.

986

"siteSearch": "A String", # Restricts results to URLs from a specified site.

987

"hq": "A String", # Appends the specified query terms to the query, as if they were combined

988

# with a logical `AND` operator.

989

"siteSearchFilter": "A String", # Specifies whether to include or exclude results from the site named in

990

# the `sitesearch` parameter. Supported values are:

991

#

992

# * `i`: include content from site

993

#

994

# * `e`: exclude content from site

995

"relatedSite": "A String", # Specifies that all search results should be pages that are related to the

996

# specified URL. The parameter value should be a URL.

997

"linkSite": "A String", # Specifies that all results should contain a link to a specific URL.

998

"totalResults": "A String", # Estimated number of total search results. May not be accurate.

999

"dateRestrict": "A String", # Restricts results to URLs based on date. Supported values include:

1000

#

1001

# * `d[number]`: requests results from the specified number of past days.

1002

#

1003

# * `w[number]`: requests results from the specified number of past weeks.

1004

#

1005

# * `m[number]`: requests results from the specified number of past months.

1006

#

1007

# * `y[number]`: requests results from the specified number of past years.

1008

"imgDominantColor": "A 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`

"exactTerms": "A String", # Identifies a phrase that all documents in the search results must

1035

# contain.

1036

"inputEncoding": "A String", # The character encoding supported for search requests.

1037

"cx": "A String", # The identifier of a custom search engine created using the Custom Search

1038

# [Control Panel](https://cse.google.com/). This is a custom property not

1039

# defined in the OpenSearch spec. This parameter is **required**.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

1040

},

1041

],

1042

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

1043

"url": { # OpenSearch template and URL.

1044

"type": "A String", # The MIME type of the OpenSearch URL template for the Custom Search API.

1045

"template": "A String", # The actual [OpenSearch

1046

# template](http://www.opensearch.org/specifications/opensearch/1.1#opensearch_url_template_syntax)

1047

# for this API.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

1048

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1049

"context": { # Metadata and refinements associated with the given search engine,

1050

# including:

1051

#

1052

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

1053

#

1054

# * A set of [facet

1055

# objects](https://developers.google.com/custom-search/docs/refinements#create)

1056

# (refinements) you can use for refining a search.

1057

"a_key": "", # Properties of the object.

1058

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1059

"kind": "A String", # Unique identifier for the type of current object. For this API, it is

1060

# customsearch#search.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

1061

"promotions": [ # The set of

1062

# [promotions](https://developers.google.com/custom-search/docs/promotions).

1063

# Present only if the custom search engine's configuration files define any

1064

# promotions for the given query.

1065

{ # Promotion result.

1066

"title": "A String", # The title of the promotion.

1067

"htmlTitle": "A String", # The title of the promotion, in HTML.

1068

"link": "A String", # The URL of the promotion.

1069

"displayLink": "A String", # An abridged version of this search's result URL, e.g. www.example.com.

1070

"bodyLines": [ # An array of block objects for this promotion. See [Google WebSearch

1071

# Protocol

1072

# reference](https://developers.google.com/custom-search/docs/xml_results)

1073

# for more information.

1074

{ # Block object belonging to a promotion.

1075

"title": "A String", # The block object's text, if it has text.

1076

"htmlTitle": "A String", # The block object's text in HTML, if it has text.

1077

"url": "A String", # The URL of the block object's link, if it has one.

1078

"link": "A String", # The anchor text of the block object's link, if it has a link.

1079

},

1080

],

1081

"image": { # Image belonging to a promotion.

1082

"source": "A String", # URL of the image for this promotion link.

1083

"height": 42, # Image height in pixels.

1084

"width": 42, # Image width in pixels.

},

},

],

"searchInformation": { # Metadata about a search operation.

1089

"totalResults": "A String", # The total number of search results returned by the query.

1090

"formattedTotalResults": "A String", # The total number of search results, formatted according to locale style.

1091

"formattedSearchTime": "A String", # The time taken for the server to return search results, formatted

1092

# according to locale style.

1093

"searchTime": 3.14, # The time taken for the server to return search results.

1094

},

1095

"items": [ # The current set of custom search results.

1096

{ # A custom search result.

1097

"fileFormat": "A String", # The file format of the search result.

1098

"image": { # Image belonging to a custom search result.

1099

"thumbnailWidth": 42, # The width of the thumbnail image, in pixels.

1100

"width": 42, # The width of the image, in pixels.

1101

"contextLink": "A String", # A URL pointing to the webpage hosting the image.

1102

"byteSize": 42, # The size of the image, in pixels.

1103

"thumbnailHeight": 42, # The height of the thumbnail image, in pixels.

1104

"height": 42, # The height of the image, in pixels.

1105

"thumbnailLink": "A String", # A URL to the thumbnail image.

1106

},

1107

"formattedUrl": "A String", # The URL displayed after the snippet for each search result.

1108

"mime": "A String", # The MIME type of the search result.

1109

"displayLink": "A String", # An abridged version of this search result’s URL, e.g. www.example.com.

1110

"cacheId": "A String", # Indicates the ID of Google's cached version of the search result.

1111

"htmlTitle": "A String", # The title of the search result, in HTML.

1112

"snippet": "A String", # The snippet of the search result, in plain text.

1113

"labels": [ # Encapsulates all information about [refinement

1114

# labels](https://developers.google.com/custom-search/docs/xml_results).

1115

{ # Refinement label associated with a custom search result.

1116

"displayName": "A String", # The display name of a refinement label. This is the name you should

1117

# display in your user interface.

1118

"name": "A String", # The name of a refinement label, which you can use to refine searches.

1119

# Don't display this in your user interface; instead, use displayName.

1120

"label_with_op": "A String", # Refinement label and the associated refinement operation.

1121

},

1122

],

1123

"title": "A String", # The title of the search result, in plain text.

1124

"link": "A String", # The full URL to which the search result is pointing, e.g.

1125

# http://www.example.com/foo/bar.

1126

"htmlSnippet": "A String", # The snippet of the search result, in HTML.

1127

"htmlFormattedUrl": "A String", # The HTML-formatted URL displayed after the snippet for each search result.

1128

"kind": "A String", # A unique identifier for the type of current object. For this API, it is

1129

# `customsearch#result.`

1130

"pagemap": { # Contains

1131

# [PageMap](https://developers.google.com/custom-search/docs/structured_data#pagemaps)

1132

# information for this search result.

1133

"a_key": "", # Properties of the object.

},

},

],

"spelling": { # Spell correction information for a query.

1138

"correctedQuery": "A String", # The corrected query.

1139

"htmlCorrectedQuery": "A String", # The corrected query, formatted in HTML.

1140

},

John Asmuth