-
Notifications
You must be signed in to change notification settings - Fork 843
/
news.go
809 lines (780 loc) · 62.1 KB
/
news.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
package newssearch
// Copyright (c) Microsoft and contributors. All rights reserved.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
//
// See the License for the specific language governing permissions and
// limitations under the License.
//
// Code generated by Microsoft (R) AutoRest Code Generator.
// Changes may cause incorrect behavior and will be lost if the code is regenerated.
import (
"context"
"github.com/Azure/go-autorest/autorest"
"github.com/Azure/go-autorest/autorest/azure"
"net/http"
)
// NewsClient is the the News Search API lets you send a search query to Bing and get back a list of news that are
// relevant to the search query. This section provides technical details about the query parameters and headers that
// you use to request news and the JSON response objects that contain them. For examples that show how to make
// requests, see [Searching the web for
// news](https://docs.microsoft.com/en-us/azure/cognitive-services/bing-news-search/search-the-web).
type NewsClient struct {
BaseClient
}
// NewNewsClient creates an instance of the NewsClient client.
func NewNewsClient() NewsClient {
return NewNewsClientWithBaseURI(DefaultBaseURI)
}
// NewNewsClientWithBaseURI creates an instance of the NewsClient client.
func NewNewsClientWithBaseURI(baseURI string) NewsClient {
return NewsClient{NewWithBaseURI(baseURI)}
}
// Category sends the category request.
//
// acceptLanguage is a comma-delimited list of one or more languages to use for user interface strings. The list is
// in decreasing order of preference. For additional information, including expected format, see
// [RFC2616](http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html). This header and the
// [setLang](https://docs.microsoft.com/en-us/rest/api/cognitiveservices/bing-news-api-v7-reference#setlang) query
// parameter are mutually exclusive; do not specify both. If you set this header, you must also specify the
// [cc](https://docs.microsoft.com/en-us/rest/api/cognitiveservices/bing-news-api-v7-reference#cc) query parameter.
// To determine the market to return results for, Bing uses the first supported language it finds from the list and
// combines it with the cc parameter value. If the list does not include a supported language, Bing finds the
// closest language and market that supports the request or it uses an aggregated or default market for the
// results. To determine the market that Bing used, see the BingAPIs-Market header. Use this header and the cc
// query parameter only if you specify multiple languages. Otherwise, use the
// [mkt](https://docs.microsoft.com/en-us/rest/api/cognitiveservices/bing-news-api-v7-reference#mkt) and
// [setLang](https://docs.microsoft.com/en-us/rest/api/cognitiveservices/bing-news-api-v7-reference#setlang) query
// parameters. A user interface string is a string that's used as a label in a user interface. There are few user
// interface strings in the JSON response objects. Any links to Bing.com properties in the response objects apply
// the specified language. userAgent is the user agent originating the request. Bing uses the user agent to provide
// mobile users with an optimized experience. Although optional, you are encouraged to always specify this header.
// The user-agent should be the same string that any commonly used browser sends. For information about user
// agents, see [RFC 2616](http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html). The following are examples of
// user-agent strings. Windows Phone: Mozilla/5.0 (compatible; MSIE 10.0; Windows Phone 8.0; Trident/6.0;
// IEMobile/10.0; ARM; Touch; NOKIA; Lumia 822). Android: Mozilla / 5.0 (Linux; U; Android 2.3.5; en - us; SCH -
// I500 Build / GINGERBREAD) AppleWebKit / 533.1 (KHTML; like Gecko) Version / 4.0 Mobile Safari / 533.1. iPhone:
// Mozilla / 5.0 (iPhone; CPU iPhone OS 6_1 like Mac OS X) AppleWebKit / 536.26 (KHTML; like Gecko) Mobile / 10B142
// iPhone4; 1 BingWeb / 3.03.1428.20120423. PC: Mozilla / 5.0 (Windows NT 6.3; WOW64; Trident / 7.0; Touch;
// rv:11.0) like Gecko. iPad: Mozilla / 5.0 (iPad; CPU OS 7_0 like Mac OS X) AppleWebKit / 537.51.1 (KHTML, like
// Gecko) Version / 7.0 Mobile / 11A465 Safari / 9537.53 clientID is bing uses this header to provide users with
// consistent behavior across Bing API calls. Bing often flights new features and improvements, and it uses the
// client ID as a key for assigning traffic on different flights. If you do not use the same client ID for a user
// across multiple requests, then Bing may assign the user to multiple conflicting flights. Being assigned to
// multiple conflicting flights can lead to an inconsistent user experience. For example, if the second request has
// a different flight assignment than the first, the experience may be unexpected. Also, Bing can use the client ID
// to tailor web results to that client ID’s search history, providing a richer experience for the user. Bing also
// uses this header to help improve result rankings by analyzing the activity generated by a client ID. The
// relevance improvements help with better quality of results delivered by Bing APIs and in turn enables higher
// click-through rates for the API consumer. IMPORTANT: Although optional, you should consider this header
// required. Persisting the client ID across multiple requests for the same end user and device combination enables
// 1) the API consumer to receive a consistent user experience, and 2) higher click-through rates via better
// quality of results from the Bing APIs. Each user that uses your application on the device must have a unique,
// Bing generated client ID. If you do not include this header in the request, Bing generates an ID and returns it
// in the X-MSEdge-ClientID response header. The only time that you should NOT include this header in a request is
// the first time the user uses your app on that device. Use the client ID for each Bing API request that your app
// makes for this user on the device. Persist the client ID. To persist the ID in a browser app, use a persistent
// HTTP cookie to ensure the ID is used across all sessions. Do not use a session cookie. For other apps such as
// mobile apps, use the device's persistent storage to persist the ID. The next time the user uses your app on that
// device, get the client ID that you persisted. Bing responses may or may not include this header. If the response
// includes this header, capture the client ID and use it for all subsequent Bing requests for the user on that
// device. If you include the X-MSEdge-ClientID, you must not include cookies in the request. clientIP is the IPv4
// or IPv6 address of the client device. The IP address is used to discover the user's location. Bing uses the
// location information to determine safe search behavior. Although optional, you are encouraged to always specify
// this header and the X-Search-Location header. Do not obfuscate the address (for example, by changing the last
// octet to 0). Obfuscating the address results in the location not being anywhere near the device's actual
// location, which may result in Bing serving erroneous results. location is a semicolon-delimited list of
// key/value pairs that describe the client's geographical location. Bing uses the location information to
// determine safe search behavior and to return relevant local content. Specify the key/value pair as
// <key>:<value>. The following are the keys that you use to specify the user's location. lat (required): The
// latitude of the client's location, in degrees. The latitude must be greater than or equal to -90.0 and less than
// or equal to +90.0. Negative values indicate southern latitudes and positive values indicate northern latitudes.
// long (required): The longitude of the client's location, in degrees. The longitude must be greater than or equal
// to -180.0 and less than or equal to +180.0. Negative values indicate western longitudes and positive values
// indicate eastern longitudes. re (required): The radius, in meters, which specifies the horizontal accuracy of
// the coordinates. Pass the value returned by the device's location service. Typical values might be 22m for
// GPS/Wi-Fi, 380m for cell tower triangulation, and 18,000m for reverse IP lookup. ts (optional): The UTC UNIX
// timestamp of when the client was at the location. (The UNIX timestamp is the number of seconds since January 1,
// 1970.) head (optional): The client's relative heading or direction of travel. Specify the direction of travel as
// degrees from 0 through 360, counting clockwise relative to true north. Specify this key only if the sp key is
// nonzero. sp (optional): The horizontal velocity (speed), in meters per second, that the client device is
// traveling. alt (optional): The altitude of the client device, in meters. are (optional): The radius, in meters,
// that specifies the vertical accuracy of the coordinates. Specify this key only if you specify the alt key.
// Although many of the keys are optional, the more information that you provide, the more accurate the location
// results are. Although optional, you are encouraged to always specify the user's geographical location. Providing
// the location is especially important if the client's IP address does not accurately reflect the user's physical
// location (for example, if the client uses VPN). For optimal results, you should include this header and the
// X-MSEdge-ClientIP header, but at a minimum, you should include this header. countryCode is a 2-character country
// code of the country where the results come from. This API supports only the United States market. If you specify
// this query parameter, it must be set to us. If you set this parameter, you must also specify the Accept-Language
// header. Bing uses the first supported language it finds from the languages list, and combine that language with
// the country code that you specify to determine the market to return results for. If the languages list does not
// include a supported language, Bing finds the closest language and market that supports the request, or it may
// use an aggregated or default market for the results instead of a specified one. You should use this query
// parameter and the Accept-Language query parameter only if you specify multiple languages; otherwise, you should
// use the mkt and setLang query parameters. This parameter and the mkt query parameter are mutually exclusive—do
// not specify both. category is the category of articles to return. For example, Sports articles or Entertainment
// articles. For a list of possible categories, see [News Categories by
// Market](https://docs.microsoft.com/en-us/rest/api/cognitiveservices/bing-news-api-v7-reference#categories-by-market).
// Use this parameter only with News Category API. If you do not specify this parameter, the response includes
// both: Headline articles typically published in the last 24 hours from any category and articles from each parent
// category (up to four articles). If the article is a headline, the article's headline field is set to true. By
// default, the response includes up to 12 headline articles. To specify the number of headline articles to return,
// set the
// [headlineCount](https://docs.microsoft.com/en-us/rest/api/cognitiveservices/bing-news-api-v7-reference#headlineCount)
// query parameter. count is the number of news articles to return in the response. The actual number delivered may
// be less than requested. The default is 10 and the maximum value is 100. The actual number delivered may be less
// than requested.You may use this parameter along with the offset parameter to page results. For example, if your
// user interface displays 20 articles per page, set count to 20 and offset to 0 to get the first page of results.
// For each subsequent page, increment offset by 20 (for example, 0, 20, 40). It is possible for multiple pages to
// include some overlap in results. If you do not specify the
// [category](https://docs.microsoft.com/en-us/rest/api/cognitiveservices/bing-news-api-v7-reference#category)
// parameter, Bing ignores this parameter. headlineCount is the number of headline articles to return in the
// response. The default is 12. Specify this parameter only if you do not specify the
// [category](https://docs.microsoft.com/en-us/rest/api/cognitiveservices/bing-news-api-v7-reference#category)
// parameter. market is the market where the results come from. Typically, mkt is the country where the user is
// making the request from. However, it could be a different country if the user is not located in a country where
// Bing delivers results. The market must be in the form <language code>-<country code>. For example, en-US. The
// string is case insensitive. For a list of possible market values, see [Market
// Codes](https://docs.microsoft.com/en-us/rest/api/cognitiveservices/bing-news-api-v7-reference#market-codes).
// NOTE: If known, you are encouraged to always specify the market. Specifying the market helps Bing route the
// request and return an appropriate and optimal response. If you specify a market that is not listed in [Market
// Codes](https://docs.microsoft.com/en-us/rest/api/cognitiveservices/bing-news-api-v7-reference#market-codes),
// Bing uses a best fit market code based on an internal mapping that is subject to change. This parameter and the
// [cc](https://docs.microsoft.com/en-us/rest/api/cognitiveservices/bing-news-api-v7-reference#cc) query parameter
// are mutually exclusive—do not specify both. offset is the zero-based offset that indicates the number of news to
// skip before returning news. The default is 0. The offset should be less than
// ([totalEstimatedMatches](https://docs.microsoft.com/en-us/rest/api/cognitiveservices/bing-news-api-v7-reference#news-totalmatches)
// - count). Use this parameter along with the count parameter to page results. For example, if your user interface
// displays 20 news per page, set count to 20 and offset to 0 to get the first page of results. For each subsequent
// page, increment offset by 20 (for example, 0, 20, 40). It is possible for multiple pages to include some overlap
// in results. If you do not specify the
// [category](https://docs.microsoft.com/en-us/rest/api/cognitiveservices/bing-news-api-v7-reference#category)
// parameter, Bing ignores this parameter. originalImage is a Boolean value that determines whether the image's
// contentUrl contains a URL that points to a thumbnail of the original article's image or the image itself. If the
// article includes an image, and this parameter is set to true, the image's contentUrl property contains a URL
// that you may use to download the original image from the publisher's website. Otherwise, if this parameter is
// false, the image's contentUrl and thumbnailUrl URLs both point to the same thumbnail image. Use this parameter
// only with the News Search API or News Category API. Trending Topics API ignore this parameter. safeSearch is
// filter news for adult content. The following are the possible filter values. Off: Return news articles with
// adult text, images, or videos. Moderate: Return news articles with adult text but not adult images or videos.
// Strict: Do not return news articles with adult text, images, or videos. If the request comes from a market that
// Bing's adult policy requires that safeSearch is set to Strict, Bing ignores the safeSearch value and uses
// Strict. If you use the site: query operator, there is the chance that the response may contain adult content
// regardless of what the safeSearch query parameter is set to. Use site: only if you are aware of the content on
// the site and your scenario supports the possibility of adult content. setLang is the language to use for user
// interface strings. Specify the language using the ISO 639-1 2-letter language code. For example, the language
// code for English is EN. The default is EN (English). Although optional, you should always specify the language.
// Typically, you set setLang to the same language specified by mkt unless the user wants the user interface
// strings displayed in a different language. This parameter and the
// [Accept-Language](https://docs.microsoft.com/en-us/rest/api/cognitiveservices/bing-news-api-v7-reference#acceptlanguage)
// header are mutually exclusive; do not specify both. A user interface string is a string that's used as a label
// in a user interface. There are few user interface strings in the JSON response objects. Also, any links to
// Bing.com properties in the response objects apply the specified language. textDecorations is a Boolean value
// that determines whether display strings contain decoration markers such as hit highlighting characters. If true,
// the strings may include markers. The default is false. To specify whether to use Unicode characters or HTML tags
// as the markers, see the
// [textFormat](https://docs.microsoft.com/en-us/rest/api/cognitiveservices/bing-news-api-v7-reference#textformat)
// query parameter. For information about hit highlighting, see [Hit
// Highlighting](https://docs.microsoft.com/azure/cognitive-services/bing-news-search/hit-highlighting). textFormat
// is the type of markers to use for text decorations (see the textDecorations query parameter). Possible values
// are Raw—Use Unicode characters to mark content that needs special formatting. The Unicode characters are in the
// range E000 through E019. For example, Bing uses E000 and E001 to mark the beginning and end of query terms for
// hit highlighting. HTML—Use HTML tags to mark content that needs special formatting. For example, use <b> tags to
// highlight query terms in display strings. The default is Raw. For display strings that contain escapable HTML
// characters such as <, >, and &, if textFormat is set to HTML, Bing escapes the characters as appropriate (for
// example, < is escaped to <).
func (client NewsClient) Category(ctx context.Context, acceptLanguage string, userAgent string, clientID string, clientIP string, location string, countryCode string, category string, count *int32, headlineCount *int32, market string, offset *int32, originalImage *bool, safeSearch SafeSearch, setLang string, textDecorations *bool, textFormat TextFormat) (result News, err error) {
req, err := client.CategoryPreparer(ctx, acceptLanguage, userAgent, clientID, clientIP, location, countryCode, category, count, headlineCount, market, offset, originalImage, safeSearch, setLang, textDecorations, textFormat)
if err != nil {
err = autorest.NewErrorWithError(err, "newssearch.NewsClient", "Category", nil, "Failure preparing request")
return
}
resp, err := client.CategorySender(req)
if err != nil {
result.Response = autorest.Response{Response: resp}
err = autorest.NewErrorWithError(err, "newssearch.NewsClient", "Category", resp, "Failure sending request")
return
}
result, err = client.CategoryResponder(resp)
if err != nil {
err = autorest.NewErrorWithError(err, "newssearch.NewsClient", "Category", resp, "Failure responding to request")
}
return
}
// CategoryPreparer prepares the Category request.
func (client NewsClient) CategoryPreparer(ctx context.Context, acceptLanguage string, userAgent string, clientID string, clientIP string, location string, countryCode string, category string, count *int32, headlineCount *int32, market string, offset *int32, originalImage *bool, safeSearch SafeSearch, setLang string, textDecorations *bool, textFormat TextFormat) (*http.Request, error) {
queryParameters := map[string]interface{}{}
if len(countryCode) > 0 {
queryParameters["cc"] = autorest.Encode("query", countryCode)
}
if len(category) > 0 {
queryParameters["category"] = autorest.Encode("query", category)
}
if count != nil {
queryParameters["count"] = autorest.Encode("query", *count)
}
if headlineCount != nil {
queryParameters["headlineCount"] = autorest.Encode("query", *headlineCount)
}
if len(market) > 0 {
queryParameters["mkt"] = autorest.Encode("query", market)
}
if offset != nil {
queryParameters["offset"] = autorest.Encode("query", *offset)
}
if originalImage != nil {
queryParameters["originalImg"] = autorest.Encode("query", *originalImage)
}
if len(string(safeSearch)) > 0 {
queryParameters["safeSearch"] = autorest.Encode("query", safeSearch)
}
if len(setLang) > 0 {
queryParameters["setLang"] = autorest.Encode("query", setLang)
}
if textDecorations != nil {
queryParameters["textDecorations"] = autorest.Encode("query", *textDecorations)
}
if len(string(textFormat)) > 0 {
queryParameters["textFormat"] = autorest.Encode("query", textFormat)
}
preparer := autorest.CreatePreparer(
autorest.AsGet(),
autorest.WithBaseURL(client.BaseURI),
autorest.WithPath("/news"),
autorest.WithQueryParameters(queryParameters),
autorest.WithHeader("X-BingApis-SDK", "true"))
if len(acceptLanguage) > 0 {
preparer = autorest.DecoratePreparer(preparer,
autorest.WithHeader("Accept-Language", autorest.String(acceptLanguage)))
}
if len(userAgent) > 0 {
preparer = autorest.DecoratePreparer(preparer,
autorest.WithHeader("User-Agent", autorest.String(userAgent)))
}
if len(clientID) > 0 {
preparer = autorest.DecoratePreparer(preparer,
autorest.WithHeader("X-MSEdge-ClientID", autorest.String(clientID)))
}
if len(clientIP) > 0 {
preparer = autorest.DecoratePreparer(preparer,
autorest.WithHeader("X-MSEdge-ClientIP", autorest.String(clientIP)))
}
if len(location) > 0 {
preparer = autorest.DecoratePreparer(preparer,
autorest.WithHeader("X-Search-Location", autorest.String(location)))
}
return preparer.Prepare((&http.Request{}).WithContext(ctx))
}
// CategorySender sends the Category request. The method will close the
// http.Response Body if it receives an error.
func (client NewsClient) CategorySender(req *http.Request) (*http.Response, error) {
return autorest.SendWithSender(client, req,
autorest.DoRetryForStatusCodes(client.RetryAttempts, client.RetryDuration, autorest.StatusCodesForRetry...))
}
// CategoryResponder handles the response to the Category request. The method always
// closes the http.Response Body.
func (client NewsClient) CategoryResponder(resp *http.Response) (result News, err error) {
err = autorest.Respond(
resp,
client.ByInspecting(),
azure.WithErrorUnlessStatusCode(http.StatusOK),
autorest.ByUnmarshallingJSON(&result),
autorest.ByClosing())
result.Response = autorest.Response{Response: resp}
return
}
// Search sends the search request.
//
// query is the user's search query string. The query string cannot be empty. The query string may contain [Bing
// Advanced Operators](http://msdn.microsoft.com/library/ff795620.aspx). For example, to limit news to a specific
// domain, use the [site:](http://msdn.microsoft.com/library/ff795613.aspx) operator. Use this parameter only with
// the News Search API. Do not specify this parameter when calling the Trending Topics API or News Category API.
// acceptLanguage is a comma-delimited list of one or more languages to use for user interface strings. The list is
// in decreasing order of preference. For additional information, including expected format, see
// [RFC2616](http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html). This header and the
// [setLang](https://docs.microsoft.com/en-us/rest/api/cognitiveservices/bing-news-api-v7-reference#setlang) query
// parameter are mutually exclusive; do not specify both. If you set this header, you must also specify the
// [cc](https://docs.microsoft.com/en-us/rest/api/cognitiveservices/bing-news-api-v7-reference#cc) query parameter.
// To determine the market to return results for, Bing uses the first supported language it finds from the list and
// combines it with the cc parameter value. If the list does not include a supported language, Bing finds the
// closest language and market that supports the request or it uses an aggregated or default market for the
// results. To determine the market that Bing used, see the BingAPIs-Market header. Use this header and the cc
// query parameter only if you specify multiple languages. Otherwise, use the
// [mkt](https://docs.microsoft.com/en-us/rest/api/cognitiveservices/bing-news-api-v7-reference#mkt) and
// [setLang](https://docs.microsoft.com/en-us/rest/api/cognitiveservices/bing-news-api-v7-reference#setlang) query
// parameters. A user interface string is a string that's used as a label in a user interface. There are few user
// interface strings in the JSON response objects. Any links to Bing.com properties in the response objects apply
// the specified language. userAgent is the user agent originating the request. Bing uses the user agent to provide
// mobile users with an optimized experience. Although optional, you are encouraged to always specify this header.
// The user-agent should be the same string that any commonly used browser sends. For information about user
// agents, see [RFC 2616](http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html). The following are examples of
// user-agent strings. Windows Phone: Mozilla/5.0 (compatible; MSIE 10.0; Windows Phone 8.0; Trident/6.0;
// IEMobile/10.0; ARM; Touch; NOKIA; Lumia 822). Android: Mozilla / 5.0 (Linux; U; Android 2.3.5; en - us; SCH -
// I500 Build / GINGERBREAD) AppleWebKit / 533.1 (KHTML; like Gecko) Version / 4.0 Mobile Safari / 533.1. iPhone:
// Mozilla / 5.0 (iPhone; CPU iPhone OS 6_1 like Mac OS X) AppleWebKit / 536.26 (KHTML; like Gecko) Mobile / 10B142
// iPhone4; 1 BingWeb / 3.03.1428.20120423. PC: Mozilla / 5.0 (Windows NT 6.3; WOW64; Trident / 7.0; Touch;
// rv:11.0) like Gecko. iPad: Mozilla / 5.0 (iPad; CPU OS 7_0 like Mac OS X) AppleWebKit / 537.51.1 (KHTML, like
// Gecko) Version / 7.0 Mobile / 11A465 Safari / 9537.53 clientID is bing uses this header to provide users with
// consistent behavior across Bing API calls. Bing often flights new features and improvements, and it uses the
// client ID as a key for assigning traffic on different flights. If you do not use the same client ID for a user
// across multiple requests, then Bing may assign the user to multiple conflicting flights. Being assigned to
// multiple conflicting flights can lead to an inconsistent user experience. For example, if the second request has
// a different flight assignment than the first, the experience may be unexpected. Also, Bing can use the client ID
// to tailor web results to that client ID’s search history, providing a richer experience for the user. Bing also
// uses this header to help improve result rankings by analyzing the activity generated by a client ID. The
// relevance improvements help with better quality of results delivered by Bing APIs and in turn enables higher
// click-through rates for the API consumer. IMPORTANT: Although optional, you should consider this header
// required. Persisting the client ID across multiple requests for the same end user and device combination enables
// 1) the API consumer to receive a consistent user experience, and 2) higher click-through rates via better
// quality of results from the Bing APIs. Each user that uses your application on the device must have a unique,
// Bing generated client ID. If you do not include this header in the request, Bing generates an ID and returns it
// in the X-MSEdge-ClientID response header. The only time that you should NOT include this header in a request is
// the first time the user uses your app on that device. Use the client ID for each Bing API request that your app
// makes for this user on the device. Persist the client ID. To persist the ID in a browser app, use a persistent
// HTTP cookie to ensure the ID is used across all sessions. Do not use a session cookie. For other apps such as
// mobile apps, use the device's persistent storage to persist the ID. The next time the user uses your app on that
// device, get the client ID that you persisted. Bing responses may or may not include this header. If the response
// includes this header, capture the client ID and use it for all subsequent Bing requests for the user on that
// device. If you include the X-MSEdge-ClientID, you must not include cookies in the request. clientIP is the IPv4
// or IPv6 address of the client device. The IP address is used to discover the user's location. Bing uses the
// location information to determine safe search behavior. Although optional, you are encouraged to always specify
// this header and the X-Search-Location header. Do not obfuscate the address (for example, by changing the last
// octet to 0). Obfuscating the address results in the location not being anywhere near the device's actual
// location, which may result in Bing serving erroneous results. location is a semicolon-delimited list of
// key/value pairs that describe the client's geographical location. Bing uses the location information to
// determine safe search behavior and to return relevant local content. Specify the key/value pair as
// <key>:<value>. The following are the keys that you use to specify the user's location. lat (required): The
// latitude of the client's location, in degrees. The latitude must be greater than or equal to -90.0 and less than
// or equal to +90.0. Negative values indicate southern latitudes and positive values indicate northern latitudes.
// long (required): The longitude of the client's location, in degrees. The longitude must be greater than or equal
// to -180.0 and less than or equal to +180.0. Negative values indicate western longitudes and positive values
// indicate eastern longitudes. re (required): The radius, in meters, which specifies the horizontal accuracy of
// the coordinates. Pass the value returned by the device's location service. Typical values might be 22m for
// GPS/Wi-Fi, 380m for cell tower triangulation, and 18,000m for reverse IP lookup. ts (optional): The UTC UNIX
// timestamp of when the client was at the location. (The UNIX timestamp is the number of seconds since January 1,
// 1970.) head (optional): The client's relative heading or direction of travel. Specify the direction of travel as
// degrees from 0 through 360, counting clockwise relative to true north. Specify this key only if the sp key is
// nonzero. sp (optional): The horizontal velocity (speed), in meters per second, that the client device is
// traveling. alt (optional): The altitude of the client device, in meters. are (optional): The radius, in meters,
// that specifies the vertical accuracy of the coordinates. Specify this key only if you specify the alt key.
// Although many of the keys are optional, the more information that you provide, the more accurate the location
// results are. Although optional, you are encouraged to always specify the user's geographical location. Providing
// the location is especially important if the client's IP address does not accurately reflect the user's physical
// location (for example, if the client uses VPN). For optimal results, you should include this header and the
// X-MSEdge-ClientIP header, but at a minimum, you should include this header. countryCode is a 2-character country
// code of the country where the results come from. This API supports only the United States market. If you specify
// this query parameter, it must be set to us. If you set this parameter, you must also specify the Accept-Language
// header. Bing uses the first supported language it finds from the languages list, and combine that language with
// the country code that you specify to determine the market to return results for. If the languages list does not
// include a supported language, Bing finds the closest language and market that supports the request, or it may
// use an aggregated or default market for the results instead of a specified one. You should use this query
// parameter and the Accept-Language query parameter only if you specify multiple languages; otherwise, you should
// use the mkt and setLang query parameters. This parameter and the mkt query parameter are mutually exclusive—do
// not specify both. count is the number of news articles to return in the response. The actual number delivered
// may be less than requested. The default is 10 and the maximum value is 100. The actual number delivered may be
// less than requested.You may use this parameter along with the offset parameter to page results. For example, if
// your user interface displays 20 articles per page, set count to 20 and offset to 0 to get the first page of
// results. For each subsequent page, increment offset by 20 (for example, 0, 20, 40). It is possible for multiple
// pages to include some overlap in results. freshness is filter news by the date and time that Bing discovered the
// news. The following are the possible filter values. Day: Return news discovered within the last 24 hours. Week:
// Return news discovered within the last 7 days. Month: Return news discovered within the last 30 days. Use this
// parameter only with the News Search API. Do not specify this parameter when calling the News Category API or the
// Trending Topics API. market is the market where the results come from. Typically, mkt is the country where the
// user is making the request from. However, it could be a different country if the user is not located in a
// country where Bing delivers results. The market must be in the form <language code>-<country code>. For example,
// en-US. The string is case insensitive. For a list of possible market values, see [Market
// Codes](https://docs.microsoft.com/en-us/rest/api/cognitiveservices/bing-news-api-v7-reference#market-codes).
// NOTE: If known, you are encouraged to always specify the market. Specifying the market helps Bing route the
// request and return an appropriate and optimal response. If you specify a market that is not listed in [Market
// Codes](https://docs.microsoft.com/en-us/rest/api/cognitiveservices/bing-news-api-v7-reference#market-codes),
// Bing uses a best fit market code based on an internal mapping that is subject to change. This parameter and the
// [cc](https://docs.microsoft.com/en-us/rest/api/cognitiveservices/bing-news-api-v7-reference#cc) query parameter
// are mutually exclusive—do not specify both. offset is the zero-based offset that indicates the number of news to
// skip before returning news. The default is 0. The offset should be less than
// ([totalEstimatedMatches](https://docs.microsoft.com/en-us/rest/api/cognitiveservices/bing-news-api-v7-reference#news-totalmatches)
// - count). Use this parameter along with the count parameter to page results. For example, if your user interface
// displays 20 news per page, set count to 20 and offset to 0 to get the first page of results. For each subsequent
// page, increment offset by 20 (for example, 0, 20, 40). It is possible for multiple pages to include some overlap
// in results. originalImage is a Boolean value that determines whether the image's contentUrl contains a URL that
// points to a thumbnail of the original article's image or the image itself. If the article includes an image, and
// this parameter is set to true, the image's contentUrl property contains a URL that you may use to download the
// original image from the publisher's website. Otherwise, if this parameter is false, the image's contentUrl and
// thumbnailUrl URLs both point to the same thumbnail image. Use this parameter only with the News Search API. Do
// not specify this parameter when calling the Trending Topics API or News Category API. safeSearch is filter news
// for adult content. The following are the possible filter values. Off: Return news articles with adult text,
// images, or videos. Moderate: Return news articles with adult text but not adult images or videos. Strict: Do not
// return news articles with adult text, images, or videos. If the request comes from a market that Bing's adult
// policy requires that safeSearch is set to Strict, Bing ignores the safeSearch value and uses Strict. If you use
// the site: query operator, there is the chance that the response may contain adult content regardless of what the
// safeSearch query parameter is set to. Use site: only if you are aware of the content on the site and your
// scenario supports the possibility of adult content. setLang is the language to use for user interface strings.
// Specify the language using the ISO 639-1 2-letter language code. For example, the language code for English is
// EN. The default is EN (English). Although optional, you should always specify the language. Typically, you set
// setLang to the same language specified by mkt unless the user wants the user interface strings displayed in a
// different language. This parameter and the
// [Accept-Language](https://docs.microsoft.com/en-us/rest/api/cognitiveservices/bing-news-api-v7-reference#acceptlanguage)
// header are mutually exclusive; do not specify both. A user interface string is a string that's used as a label
// in a user interface. There are few user interface strings in the JSON response objects. Also, any links to
// Bing.com properties in the response objects apply the specified language. sortBy is the order to return the news
// in. The following are the possible case-insensitive values. Date: If the request is through the News Search API,
// the response returns news articles sorted by date from the most recent to the oldest. If the request is through
// the News Trending Topics API, the response returns trending topics sorted by date from the most recent to the
// oldest. textDecorations is a Boolean value that determines whether display strings contain decoration markers
// such as hit highlighting characters. If true, the strings may include markers. The default is false. To specify
// whether to use Unicode characters or HTML tags as the markers, see the
// [textFormat](https://docs.microsoft.com/en-us/rest/api/cognitiveservices/bing-news-api-v7-reference#textformat)
// query parameter. For information about hit highlighting, see [Hit
// Highlighting](https://docs.microsoft.com/azure/cognitive-services/bing-news-search/hit-highlighting). textFormat
// is the type of markers to use for text decorations (see the textDecorations query parameter). Possible values
// are Raw—Use Unicode characters to mark content that needs special formatting. The Unicode characters are in the
// range E000 through E019. For example, Bing uses E000 and E001 to mark the beginning and end of query terms for
// hit highlighting. HTML—Use HTML tags to mark content that needs special formatting. For example, use <b> tags to
// highlight query terms in display strings. The default is Raw. For display strings that contain escapable HTML
// characters such as <, >, and &, if textFormat is set to HTML, Bing escapes the characters as appropriate (for
// example, < is escaped to <).
func (client NewsClient) Search(ctx context.Context, query string, acceptLanguage string, userAgent string, clientID string, clientIP string, location string, countryCode string, count *int32, freshness Freshness, market string, offset *int32, originalImage *bool, safeSearch SafeSearch, setLang string, sortBy string, textDecorations *bool, textFormat TextFormat) (result News, err error) {
req, err := client.SearchPreparer(ctx, query, acceptLanguage, userAgent, clientID, clientIP, location, countryCode, count, freshness, market, offset, originalImage, safeSearch, setLang, sortBy, textDecorations, textFormat)
if err != nil {
err = autorest.NewErrorWithError(err, "newssearch.NewsClient", "Search", nil, "Failure preparing request")
return
}
resp, err := client.SearchSender(req)
if err != nil {
result.Response = autorest.Response{Response: resp}
err = autorest.NewErrorWithError(err, "newssearch.NewsClient", "Search", resp, "Failure sending request")
return
}
result, err = client.SearchResponder(resp)
if err != nil {
err = autorest.NewErrorWithError(err, "newssearch.NewsClient", "Search", resp, "Failure responding to request")
}
return
}
// SearchPreparer prepares the Search request.
func (client NewsClient) SearchPreparer(ctx context.Context, query string, acceptLanguage string, userAgent string, clientID string, clientIP string, location string, countryCode string, count *int32, freshness Freshness, market string, offset *int32, originalImage *bool, safeSearch SafeSearch, setLang string, sortBy string, textDecorations *bool, textFormat TextFormat) (*http.Request, error) {
queryParameters := map[string]interface{}{
"q": autorest.Encode("query", query),
}
if len(countryCode) > 0 {
queryParameters["cc"] = autorest.Encode("query", countryCode)
}
if count != nil {
queryParameters["count"] = autorest.Encode("query", *count)
}
if len(string(freshness)) > 0 {
queryParameters["freshness"] = autorest.Encode("query", freshness)
}
if len(market) > 0 {
queryParameters["mkt"] = autorest.Encode("query", market)
}
if offset != nil {
queryParameters["offset"] = autorest.Encode("query", *offset)
}
if originalImage != nil {
queryParameters["originalImg"] = autorest.Encode("query", *originalImage)
}
if len(string(safeSearch)) > 0 {
queryParameters["safeSearch"] = autorest.Encode("query", safeSearch)
}
if len(setLang) > 0 {
queryParameters["setLang"] = autorest.Encode("query", setLang)
}
if len(sortBy) > 0 {
queryParameters["sortBy"] = autorest.Encode("query", sortBy)
}
if textDecorations != nil {
queryParameters["textDecorations"] = autorest.Encode("query", *textDecorations)
}
if len(string(textFormat)) > 0 {
queryParameters["textFormat"] = autorest.Encode("query", textFormat)
}
preparer := autorest.CreatePreparer(
autorest.AsGet(),
autorest.WithBaseURL(client.BaseURI),
autorest.WithPath("/news/search"),
autorest.WithQueryParameters(queryParameters),
autorest.WithHeader("X-BingApis-SDK", "true"))
if len(acceptLanguage) > 0 {
preparer = autorest.DecoratePreparer(preparer,
autorest.WithHeader("Accept-Language", autorest.String(acceptLanguage)))
}
if len(userAgent) > 0 {
preparer = autorest.DecoratePreparer(preparer,
autorest.WithHeader("User-Agent", autorest.String(userAgent)))
}
if len(clientID) > 0 {
preparer = autorest.DecoratePreparer(preparer,
autorest.WithHeader("X-MSEdge-ClientID", autorest.String(clientID)))
}
if len(clientIP) > 0 {
preparer = autorest.DecoratePreparer(preparer,
autorest.WithHeader("X-MSEdge-ClientIP", autorest.String(clientIP)))
}
if len(location) > 0 {
preparer = autorest.DecoratePreparer(preparer,
autorest.WithHeader("X-Search-Location", autorest.String(location)))
}
return preparer.Prepare((&http.Request{}).WithContext(ctx))
}
// SearchSender sends the Search request. The method will close the
// http.Response Body if it receives an error.
func (client NewsClient) SearchSender(req *http.Request) (*http.Response, error) {
return autorest.SendWithSender(client, req,
autorest.DoRetryForStatusCodes(client.RetryAttempts, client.RetryDuration, autorest.StatusCodesForRetry...))
}
// SearchResponder handles the response to the Search request. The method always
// closes the http.Response Body.
func (client NewsClient) SearchResponder(resp *http.Response) (result News, err error) {
err = autorest.Respond(
resp,
client.ByInspecting(),
azure.WithErrorUnlessStatusCode(http.StatusOK),
autorest.ByUnmarshallingJSON(&result),
autorest.ByClosing())
result.Response = autorest.Response{Response: resp}
return
}
// Trending sends the trending request.
//
// acceptLanguage is a comma-delimited list of one or more languages to use for user interface strings. The list is
// in decreasing order of preference. For additional information, including expected format, see
// [RFC2616](http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html). This header and the
// [setLang](https://docs.microsoft.com/en-us/rest/api/cognitiveservices/bing-news-api-v7-reference#setlang) query
// parameter are mutually exclusive; do not specify both. If you set this header, you must also specify the
// [cc](https://docs.microsoft.com/en-us/rest/api/cognitiveservices/bing-news-api-v7-reference#cc) query parameter.
// To determine the market to return results for, Bing uses the first supported language it finds from the list and
// combines it with the cc parameter value. If the list does not include a supported language, Bing finds the
// closest language and market that supports the request or it uses an aggregated or default market for the
// results. To determine the market that Bing used, see the BingAPIs-Market header. Use this header and the cc
// query parameter only if you specify multiple languages. Otherwise, use the
// [mkt](https://docs.microsoft.com/en-us/rest/api/cognitiveservices/bing-news-api-v7-reference#mkt) and
// [setLang](https://docs.microsoft.com/en-us/rest/api/cognitiveservices/bing-news-api-v7-reference#setlang) query
// parameters. A user interface string is a string that's used as a label in a user interface. There are few user
// interface strings in the JSON response objects. Any links to Bing.com properties in the response objects apply
// the specified language. userAgent is the user agent originating the request. Bing uses the user agent to provide
// mobile users with an optimized experience. Although optional, you are encouraged to always specify this header.
// The user-agent should be the same string that any commonly used browser sends. For information about user
// agents, see [RFC 2616](http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html). The following are examples of
// user-agent strings. Windows Phone: Mozilla/5.0 (compatible; MSIE 10.0; Windows Phone 8.0; Trident/6.0;
// IEMobile/10.0; ARM; Touch; NOKIA; Lumia 822). Android: Mozilla / 5.0 (Linux; U; Android 2.3.5; en - us; SCH -
// I500 Build / GINGERBREAD) AppleWebKit / 533.1 (KHTML; like Gecko) Version / 4.0 Mobile Safari / 533.1. iPhone:
// Mozilla / 5.0 (iPhone; CPU iPhone OS 6_1 like Mac OS X) AppleWebKit / 536.26 (KHTML; like Gecko) Mobile / 10B142
// iPhone4; 1 BingWeb / 3.03.1428.20120423. PC: Mozilla / 5.0 (Windows NT 6.3; WOW64; Trident / 7.0; Touch;
// rv:11.0) like Gecko. iPad: Mozilla / 5.0 (iPad; CPU OS 7_0 like Mac OS X) AppleWebKit / 537.51.1 (KHTML, like
// Gecko) Version / 7.0 Mobile / 11A465 Safari / 9537.53 clientID is bing uses this header to provide users with
// consistent behavior across Bing API calls. Bing often flights new features and improvements, and it uses the
// client ID as a key for assigning traffic on different flights. If you do not use the same client ID for a user
// across multiple requests, then Bing may assign the user to multiple conflicting flights. Being assigned to
// multiple conflicting flights can lead to an inconsistent user experience. For example, if the second request has
// a different flight assignment than the first, the experience may be unexpected. Also, Bing can use the client ID
// to tailor web results to that client ID’s search history, providing a richer experience for the user. Bing also
// uses this header to help improve result rankings by analyzing the activity generated by a client ID. The
// relevance improvements help with better quality of results delivered by Bing APIs and in turn enables higher
// click-through rates for the API consumer. IMPORTANT: Although optional, you should consider this header
// required. Persisting the client ID across multiple requests for the same end user and device combination enables
// 1) the API consumer to receive a consistent user experience, and 2) higher click-through rates via better
// quality of results from the Bing APIs. Each user that uses your application on the device must have a unique,
// Bing generated client ID. If you do not include this header in the request, Bing generates an ID and returns it
// in the X-MSEdge-ClientID response header. The only time that you should NOT include this header in a request is
// the first time the user uses your app on that device. Use the client ID for each Bing API request that your app
// makes for this user on the device. Persist the client ID. To persist the ID in a browser app, use a persistent
// HTTP cookie to ensure the ID is used across all sessions. Do not use a session cookie. For other apps such as
// mobile apps, use the device's persistent storage to persist the ID. The next time the user uses your app on that
// device, get the client ID that you persisted. Bing responses may or may not include this header. If the response
// includes this header, capture the client ID and use it for all subsequent Bing requests for the user on that
// device. If you include the X-MSEdge-ClientID, you must not include cookies in the request. clientIP is the IPv4
// or IPv6 address of the client device. The IP address is used to discover the user's location. Bing uses the
// location information to determine safe search behavior. Although optional, you are encouraged to always specify
// this header and the X-Search-Location header. Do not obfuscate the address (for example, by changing the last
// octet to 0). Obfuscating the address results in the location not being anywhere near the device's actual
// location, which may result in Bing serving erroneous results. location is a semicolon-delimited list of
// key/value pairs that describe the client's geographical location. Bing uses the location information to
// determine safe search behavior and to return relevant local content. Specify the key/value pair as
// <key>:<value>. The following are the keys that you use to specify the user's location. lat (required): The
// latitude of the client's location, in degrees. The latitude must be greater than or equal to -90.0 and less than
// or equal to +90.0. Negative values indicate southern latitudes and positive values indicate northern latitudes.
// long (required): The longitude of the client's location, in degrees. The longitude must be greater than or equal
// to -180.0 and less than or equal to +180.0. Negative values indicate western longitudes and positive values
// indicate eastern longitudes. re (required): The radius, in meters, which specifies the horizontal accuracy of
// the coordinates. Pass the value returned by the device's location service. Typical values might be 22m for
// GPS/Wi-Fi, 380m for cell tower triangulation, and 18,000m for reverse IP lookup. ts (optional): The UTC UNIX
// timestamp of when the client was at the location. (The UNIX timestamp is the number of seconds since January 1,
// 1970.) head (optional): The client's relative heading or direction of travel. Specify the direction of travel as
// degrees from 0 through 360, counting clockwise relative to true north. Specify this key only if the sp key is
// nonzero. sp (optional): The horizontal velocity (speed), in meters per second, that the client device is
// traveling. alt (optional): The altitude of the client device, in meters. are (optional): The radius, in meters,
// that specifies the vertical accuracy of the coordinates. Specify this key only if you specify the alt key.
// Although many of the keys are optional, the more information that you provide, the more accurate the location
// results are. Although optional, you are encouraged to always specify the user's geographical location. Providing
// the location is especially important if the client's IP address does not accurately reflect the user's physical
// location (for example, if the client uses VPN). For optimal results, you should include this header and the
// X-MSEdge-ClientIP header, but at a minimum, you should include this header. countryCode is a 2-character country
// code of the country where the results come from. This API supports only the United States market. If you specify
// this query parameter, it must be set to us. If you set this parameter, you must also specify the Accept-Language
// header. Bing uses the first supported language it finds from the languages list, and combine that language with
// the country code that you specify to determine the market to return results for. If the languages list does not
// include a supported language, Bing finds the closest language and market that supports the request, or it may
// use an aggregated or default market for the results instead of a specified one. You should use this query
// parameter and the Accept-Language query parameter only if you specify multiple languages; otherwise, you should
// use the mkt and setLang query parameters. This parameter and the mkt query parameter are mutually exclusive—do
// not specify both. count is the number of news articles to return in the response. The actual number delivered
// may be less than requested. The default is 10 and the maximum value is 100. The actual number delivered may be
// less than requested.You may use this parameter along with the offset parameter to page results. For example, if
// your user interface displays 20 articles per page, set count to 20 and offset to 0 to get the first page of
// results. For each subsequent page, increment offset by 20 (for example, 0, 20, 40). It is possible for multiple
// pages to include some overlap in results. market is the market where the results come from. Typically, mkt is
// the country where the user is making the request from. However, it could be a different country if the user is
// not located in a country where Bing delivers results. The market must be in the form <language code>-<country
// code>. For example, en-US. The string is case insensitive. For a list of possible market values, see [Market
// Codes](https://docs.microsoft.com/en-us/rest/api/cognitiveservices/bing-news-api-v7-reference#market-codes).
// NOTE: If known, you are encouraged to always specify the market. Specifying the market helps Bing route the
// request and return an appropriate and optimal response. If you specify a market that is not listed in [Market
// Codes](https://docs.microsoft.com/en-us/rest/api/cognitiveservices/bing-news-api-v7-reference#market-codes),
// Bing uses a best fit market code based on an internal mapping that is subject to change. This parameter and the
// [cc](https://docs.microsoft.com/en-us/rest/api/cognitiveservices/bing-news-api-v7-reference#cc) query parameter
// are mutually exclusive—do not specify both. offset is the zero-based offset that indicates the number of news to
// skip before returning news. The default is 0. The offset should be less than
// ([totalEstimatedMatches](https://docs.microsoft.com/en-us/rest/api/cognitiveservices/bing-news-api-v7-reference#news-totalmatches)
// - count). Use this parameter along with the count parameter to page results. For example, if your user interface
// displays 20 news per page, set count to 20 and offset to 0 to get the first page of results. For each subsequent
// page, increment offset by 20 (for example, 0, 20, 40). It is possible for multiple pages to include some overlap
// in results. safeSearch is filter news for adult content. The following are the possible filter values. Off:
// Return news articles with adult text, images, or videos. Moderate: Return news articles with adult text but not
// adult images or videos. Strict: Do not return news articles with adult text, images, or videos. If the request
// comes from a market that Bing's adult policy requires that safeSearch is set to Strict, Bing ignores the
// safeSearch value and uses Strict. If you use the site: query operator, there is the chance that the response may
// contain adult content regardless of what the safeSearch query parameter is set to. Use site: only if you are
// aware of the content on the site and your scenario supports the possibility of adult content. setLang is the
// language to use for user interface strings. Specify the language using the ISO 639-1 2-letter language code. For
// example, the language code for English is EN. The default is EN (English). Although optional, you should always
// specify the language. Typically, you set setLang to the same language specified by mkt unless the user wants the
// user interface strings displayed in a different language. This parameter and the
// [Accept-Language](https://docs.microsoft.com/en-us/rest/api/cognitiveservices/bing-news-api-v7-reference#acceptlanguage)
// header are mutually exclusive; do not specify both. A user interface string is a string that's used as a label
// in a user interface. There are few user interface strings in the JSON response objects. Also, any links to
// Bing.com properties in the response objects apply the specified language. since is the Unix epoch time (Unix
// timestamp) that Bing uses to select the trending topics. Bing returns trending topics that it discovered on or
// after the specified date and time, not the date the topic was published. To use this parameter, also specify the
// sortBy parameter. Use this parameter only with the News Trending Topics API. Do not specify this parameter when
// calling the News Search API or News Category API. sortBy is the order to return the news in. The following are
// the possible case-insensitive values. Date: If the request is through the News Search API, the response returns
// news articles sorted by date from the most recent to the oldest. If the request is through the News Trending
// Topics API, the response returns trending topics sorted by date from the most recent to the oldest.
// textDecorations is a Boolean value that determines whether display strings contain decoration markers such as
// hit highlighting characters. If true, the strings may include markers. The default is false. To specify whether
// to use Unicode characters or HTML tags as the markers, see the
// [textFormat](https://docs.microsoft.com/en-us/rest/api/cognitiveservices/bing-news-api-v7-reference#textformat)
// query parameter. For information about hit highlighting, see [Hit
// Highlighting](https://docs.microsoft.com/azure/cognitive-services/bing-news-search/hit-highlighting). textFormat
// is the type of markers to use for text decorations (see the textDecorations query parameter). Possible values
// are Raw—Use Unicode characters to mark content that needs special formatting. The Unicode characters are in the
// range E000 through E019. For example, Bing uses E000 and E001 to mark the beginning and end of query terms for
// hit highlighting. HTML—Use HTML tags to mark content that needs special formatting. For example, use <b> tags to
// highlight query terms in display strings. The default is Raw. For display strings that contain escapable HTML
// characters such as <, >, and &, if textFormat is set to HTML, Bing escapes the characters as appropriate (for
// example, < is escaped to <).
func (client NewsClient) Trending(ctx context.Context, acceptLanguage string, userAgent string, clientID string, clientIP string, location string, countryCode string, count *int32, market string, offset *int32, safeSearch SafeSearch, setLang string, since *int64, sortBy string, textDecorations *bool, textFormat TextFormat) (result TrendingTopics, err error) {
req, err := client.TrendingPreparer(ctx, acceptLanguage, userAgent, clientID, clientIP, location, countryCode, count, market, offset, safeSearch, setLang, since, sortBy, textDecorations, textFormat)
if err != nil {
err = autorest.NewErrorWithError(err, "newssearch.NewsClient", "Trending", nil, "Failure preparing request")
return
}
resp, err := client.TrendingSender(req)
if err != nil {
result.Response = autorest.Response{Response: resp}
err = autorest.NewErrorWithError(err, "newssearch.NewsClient", "Trending", resp, "Failure sending request")
return
}
result, err = client.TrendingResponder(resp)
if err != nil {
err = autorest.NewErrorWithError(err, "newssearch.NewsClient", "Trending", resp, "Failure responding to request")
}
return
}
// TrendingPreparer prepares the Trending request.
func (client NewsClient) TrendingPreparer(ctx context.Context, acceptLanguage string, userAgent string, clientID string, clientIP string, location string, countryCode string, count *int32, market string, offset *int32, safeSearch SafeSearch, setLang string, since *int64, sortBy string, textDecorations *bool, textFormat TextFormat) (*http.Request, error) {
queryParameters := map[string]interface{}{}
if len(countryCode) > 0 {
queryParameters["cc"] = autorest.Encode("query", countryCode)
}
if count != nil {
queryParameters["count"] = autorest.Encode("query", *count)
}
if len(market) > 0 {
queryParameters["mkt"] = autorest.Encode("query", market)
}
if offset != nil {
queryParameters["offset"] = autorest.Encode("query", *offset)
}
if len(string(safeSearch)) > 0 {
queryParameters["safeSearch"] = autorest.Encode("query", safeSearch)
}
if len(setLang) > 0 {
queryParameters["setLang"] = autorest.Encode("query", setLang)
}
if since != nil {
queryParameters["since"] = autorest.Encode("query", *since)
}
if len(sortBy) > 0 {
queryParameters["sortBy"] = autorest.Encode("query", sortBy)
}
if textDecorations != nil {
queryParameters["textDecorations"] = autorest.Encode("query", *textDecorations)
}
if len(string(textFormat)) > 0 {
queryParameters["textFormat"] = autorest.Encode("query", textFormat)
}
preparer := autorest.CreatePreparer(
autorest.AsGet(),
autorest.WithBaseURL(client.BaseURI),
autorest.WithPath("/news/trendingtopics"),
autorest.WithQueryParameters(queryParameters),
autorest.WithHeader("X-BingApis-SDK", "true"))
if len(acceptLanguage) > 0 {
preparer = autorest.DecoratePreparer(preparer,
autorest.WithHeader("Accept-Language", autorest.String(acceptLanguage)))
}
if len(userAgent) > 0 {
preparer = autorest.DecoratePreparer(preparer,
autorest.WithHeader("User-Agent", autorest.String(userAgent)))
}
if len(clientID) > 0 {
preparer = autorest.DecoratePreparer(preparer,
autorest.WithHeader("X-MSEdge-ClientID", autorest.String(clientID)))
}
if len(clientIP) > 0 {
preparer = autorest.DecoratePreparer(preparer,
autorest.WithHeader("X-MSEdge-ClientIP", autorest.String(clientIP)))
}
if len(location) > 0 {
preparer = autorest.DecoratePreparer(preparer,
autorest.WithHeader("X-Search-Location", autorest.String(location)))
}
return preparer.Prepare((&http.Request{}).WithContext(ctx))
}
// TrendingSender sends the Trending request. The method will close the
// http.Response Body if it receives an error.
func (client NewsClient) TrendingSender(req *http.Request) (*http.Response, error) {
return autorest.SendWithSender(client, req,
autorest.DoRetryForStatusCodes(client.RetryAttempts, client.RetryDuration, autorest.StatusCodesForRetry...))
}
// TrendingResponder handles the response to the Trending request. The method always
// closes the http.Response Body.
func (client NewsClient) TrendingResponder(resp *http.Response) (result TrendingTopics, err error) {
err = autorest.Respond(
resp,
client.ByInspecting(),
azure.WithErrorUnlessStatusCode(http.StatusOK),
autorest.ByUnmarshallingJSON(&result),
autorest.ByClosing())
result.Response = autorest.Response{Response: resp}
return
}