newssearch

package
v26.1.0+incompatible Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Feb 27, 2019 License: Apache-2.0 Imports: 7 Imported by: 0

Documentation

Overview

Package newssearch implements the Azure ARM Newssearch service API version 1.0.

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).

Index

Constants

View Source
const (
	// DefaultEndpoint is the default value for endpoint
	DefaultEndpoint = "https://api.cognitive.microsoft.com"
)

Variables

This section is empty.

Functions

func UserAgent

func UserAgent() string

UserAgent returns the UserAgent string to use when sending http.Requests.

func Version

func Version() string

Version returns the semantic version (see http://semver.org) of the client.

Types

type Answer

type Answer struct {
	FollowUpQueries *[]Query `json:"followUpQueries,omitempty"`
	// WebSearchURL - The URL To Bing's search result for this item.
	WebSearchURL *string `json:"webSearchUrl,omitempty"`
	// ID - A String identifier.
	ID *string `json:"id,omitempty"`
	// Type - Possible values include: 'TypeResponseBase', 'TypeNewsArticle', 'TypeNews', 'TypeSearchResultsAnswer', 'TypeImageObject', 'TypeNewsTopic', 'TypeAnswer', 'TypeArticle', 'TypeThing', 'TypeResponse', 'TypeTrendingTopics', 'TypeVideoObject', 'TypeCreativeWork', 'TypeOrganization', 'TypeIdentifiable', 'TypeErrorResponse', 'TypeMediaObject'
	Type Type `json:"_type,omitempty"`
}

Answer defines an answer.

func (Answer) AsAnswer

func (a Answer) AsAnswer() (*Answer, bool)

AsAnswer is the BasicResponseBase implementation for Answer.

func (Answer) AsArticle

func (a Answer) AsArticle() (*Article, bool)

AsArticle is the BasicResponseBase implementation for Answer.

func (Answer) AsBasicAnswer

func (a Answer) AsBasicAnswer() (BasicAnswer, bool)

AsBasicAnswer is the BasicResponseBase implementation for Answer.

func (Answer) AsBasicArticle

func (a Answer) AsBasicArticle() (BasicArticle, bool)

AsBasicArticle is the BasicResponseBase implementation for Answer.

func (Answer) AsBasicCreativeWork

func (a Answer) AsBasicCreativeWork() (BasicCreativeWork, bool)

AsBasicCreativeWork is the BasicResponseBase implementation for Answer.

func (Answer) AsBasicIdentifiable

func (a Answer) AsBasicIdentifiable() (BasicIdentifiable, bool)

AsBasicIdentifiable is the BasicResponseBase implementation for Answer.

func (Answer) AsBasicMediaObject

func (a Answer) AsBasicMediaObject() (BasicMediaObject, bool)

AsBasicMediaObject is the BasicResponseBase implementation for Answer.

func (Answer) AsBasicResponse

func (a Answer) AsBasicResponse() (BasicResponse, bool)

AsBasicResponse is the BasicResponseBase implementation for Answer.

func (Answer) AsBasicResponseBase

func (a Answer) AsBasicResponseBase() (BasicResponseBase, bool)

AsBasicResponseBase is the BasicResponseBase implementation for Answer.

func (Answer) AsBasicSearchResultsAnswer

func (a Answer) AsBasicSearchResultsAnswer() (BasicSearchResultsAnswer, bool)

AsBasicSearchResultsAnswer is the BasicResponseBase implementation for Answer.

func (Answer) AsBasicThing

func (a Answer) AsBasicThing() (BasicThing, bool)

AsBasicThing is the BasicResponseBase implementation for Answer.

func (Answer) AsCreativeWork

func (a Answer) AsCreativeWork() (*CreativeWork, bool)

AsCreativeWork is the BasicResponseBase implementation for Answer.

func (Answer) AsErrorResponse

func (a Answer) AsErrorResponse() (*ErrorResponse, bool)

AsErrorResponse is the BasicResponseBase implementation for Answer.

func (Answer) AsIdentifiable

func (a Answer) AsIdentifiable() (*Identifiable, bool)

AsIdentifiable is the BasicResponseBase implementation for Answer.

func (Answer) AsImageObject

func (a Answer) AsImageObject() (*ImageObject, bool)

AsImageObject is the BasicResponseBase implementation for Answer.

func (Answer) AsMediaObject

func (a Answer) AsMediaObject() (*MediaObject, bool)

AsMediaObject is the BasicResponseBase implementation for Answer.

func (Answer) AsNews

func (a Answer) AsNews() (*News, bool)

AsNews is the BasicResponseBase implementation for Answer.

func (Answer) AsNewsArticle

func (a Answer) AsNewsArticle() (*NewsArticle, bool)

AsNewsArticle is the BasicResponseBase implementation for Answer.

func (Answer) AsNewsTopic

func (a Answer) AsNewsTopic() (*NewsTopic, bool)

AsNewsTopic is the BasicResponseBase implementation for Answer.

func (Answer) AsOrganization

func (a Answer) AsOrganization() (*Organization, bool)

AsOrganization is the BasicResponseBase implementation for Answer.

func (Answer) AsResponse

func (a Answer) AsResponse() (*Response, bool)

AsResponse is the BasicResponseBase implementation for Answer.

func (Answer) AsResponseBase

func (a Answer) AsResponseBase() (*ResponseBase, bool)

AsResponseBase is the BasicResponseBase implementation for Answer.

func (Answer) AsSearchResultsAnswer

func (a Answer) AsSearchResultsAnswer() (*SearchResultsAnswer, bool)

AsSearchResultsAnswer is the BasicResponseBase implementation for Answer.

func (Answer) AsThing

func (a Answer) AsThing() (*Thing, bool)

AsThing is the BasicResponseBase implementation for Answer.

func (Answer) AsTrendingTopics

func (a Answer) AsTrendingTopics() (*TrendingTopics, bool)

AsTrendingTopics is the BasicResponseBase implementation for Answer.

func (Answer) AsVideoObject

func (a Answer) AsVideoObject() (*VideoObject, bool)

AsVideoObject is the BasicResponseBase implementation for Answer.

func (Answer) MarshalJSON

func (a Answer) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for Answer.

type Article

type Article struct {
	// WordCount - The number of words in the text of the Article.
	WordCount *int32 `json:"wordCount,omitempty"`
	// ThumbnailURL - The URL to a thumbnail of the item.
	ThumbnailURL *string `json:"thumbnailUrl,omitempty"`
	// Provider - The source of the creative work.
	Provider *[]BasicThing `json:"provider,omitempty"`
	// DatePublished - The date on which the CreativeWork was published.
	DatePublished *string `json:"datePublished,omitempty"`
	// Video - A video of the item.
	Video *VideoObject `json:"video,omitempty"`
	// Name - The name of the thing represented by this object.
	Name *string `json:"name,omitempty"`
	// URL - The URL to get more information about the thing represented by this object.
	URL *string `json:"url,omitempty"`
	// Image - An image of the item.
	Image *ImageObject `json:"image,omitempty"`
	// Description - A short description of the item.
	Description *string `json:"description,omitempty"`
	// AlternateName - An alias for the item
	AlternateName *string `json:"alternateName,omitempty"`
	// BingID - An ID that uniquely identifies this item.
	BingID *string `json:"bingId,omitempty"`
	// WebSearchURL - The URL To Bing's search result for this item.
	WebSearchURL *string `json:"webSearchUrl,omitempty"`
	// ID - A String identifier.
	ID *string `json:"id,omitempty"`
	// Type - Possible values include: 'TypeResponseBase', 'TypeNewsArticle', 'TypeNews', 'TypeSearchResultsAnswer', 'TypeImageObject', 'TypeNewsTopic', 'TypeAnswer', 'TypeArticle', 'TypeThing', 'TypeResponse', 'TypeTrendingTopics', 'TypeVideoObject', 'TypeCreativeWork', 'TypeOrganization', 'TypeIdentifiable', 'TypeErrorResponse', 'TypeMediaObject'
	Type Type `json:"_type,omitempty"`
}

Article ...

func (Article) AsAnswer

func (a Article) AsAnswer() (*Answer, bool)

AsAnswer is the BasicResponseBase implementation for Article.

func (Article) AsArticle

func (a Article) AsArticle() (*Article, bool)

AsArticle is the BasicResponseBase implementation for Article.

func (Article) AsBasicAnswer

func (a Article) AsBasicAnswer() (BasicAnswer, bool)

AsBasicAnswer is the BasicResponseBase implementation for Article.

func (Article) AsBasicArticle

func (a Article) AsBasicArticle() (BasicArticle, bool)

AsBasicArticle is the BasicResponseBase implementation for Article.

func (Article) AsBasicCreativeWork

func (a Article) AsBasicCreativeWork() (BasicCreativeWork, bool)

AsBasicCreativeWork is the BasicResponseBase implementation for Article.

func (Article) AsBasicIdentifiable

func (a Article) AsBasicIdentifiable() (BasicIdentifiable, bool)

AsBasicIdentifiable is the BasicResponseBase implementation for Article.

func (Article) AsBasicMediaObject

func (a Article) AsBasicMediaObject() (BasicMediaObject, bool)

AsBasicMediaObject is the BasicResponseBase implementation for Article.

func (Article) AsBasicResponse

func (a Article) AsBasicResponse() (BasicResponse, bool)

AsBasicResponse is the BasicResponseBase implementation for Article.

func (Article) AsBasicResponseBase

func (a Article) AsBasicResponseBase() (BasicResponseBase, bool)

AsBasicResponseBase is the BasicResponseBase implementation for Article.

func (Article) AsBasicSearchResultsAnswer

func (a Article) AsBasicSearchResultsAnswer() (BasicSearchResultsAnswer, bool)

AsBasicSearchResultsAnswer is the BasicResponseBase implementation for Article.

func (Article) AsBasicThing

func (a Article) AsBasicThing() (BasicThing, bool)

AsBasicThing is the BasicResponseBase implementation for Article.

func (Article) AsCreativeWork

func (a Article) AsCreativeWork() (*CreativeWork, bool)

AsCreativeWork is the BasicResponseBase implementation for Article.

func (Article) AsErrorResponse

func (a Article) AsErrorResponse() (*ErrorResponse, bool)

AsErrorResponse is the BasicResponseBase implementation for Article.

func (Article) AsIdentifiable

func (a Article) AsIdentifiable() (*Identifiable, bool)

AsIdentifiable is the BasicResponseBase implementation for Article.

func (Article) AsImageObject

func (a Article) AsImageObject() (*ImageObject, bool)

AsImageObject is the BasicResponseBase implementation for Article.

func (Article) AsMediaObject

func (a Article) AsMediaObject() (*MediaObject, bool)

AsMediaObject is the BasicResponseBase implementation for Article.

func (Article) AsNews

func (a Article) AsNews() (*News, bool)

AsNews is the BasicResponseBase implementation for Article.

func (Article) AsNewsArticle

func (a Article) AsNewsArticle() (*NewsArticle, bool)

AsNewsArticle is the BasicResponseBase implementation for Article.

func (Article) AsNewsTopic

func (a Article) AsNewsTopic() (*NewsTopic, bool)

AsNewsTopic is the BasicResponseBase implementation for Article.

func (Article) AsOrganization

func (a Article) AsOrganization() (*Organization, bool)

AsOrganization is the BasicResponseBase implementation for Article.

func (Article) AsResponse

func (a Article) AsResponse() (*Response, bool)

AsResponse is the BasicResponseBase implementation for Article.

func (Article) AsResponseBase

func (a Article) AsResponseBase() (*ResponseBase, bool)

AsResponseBase is the BasicResponseBase implementation for Article.

func (Article) AsSearchResultsAnswer

func (a Article) AsSearchResultsAnswer() (*SearchResultsAnswer, bool)

AsSearchResultsAnswer is the BasicResponseBase implementation for Article.

func (Article) AsThing

func (a Article) AsThing() (*Thing, bool)

AsThing is the BasicResponseBase implementation for Article.

func (Article) AsTrendingTopics

func (a Article) AsTrendingTopics() (*TrendingTopics, bool)

AsTrendingTopics is the BasicResponseBase implementation for Article.

func (Article) AsVideoObject

func (a Article) AsVideoObject() (*VideoObject, bool)

AsVideoObject is the BasicResponseBase implementation for Article.

func (Article) MarshalJSON

func (a Article) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for Article.

func (*Article) UnmarshalJSON

func (a *Article) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for Article struct.

type BaseClient

type BaseClient struct {
	autorest.Client
	Endpoint string
}

BaseClient is the base client for Newssearch.

func New

func New() BaseClient

New creates an instance of the BaseClient client.

func NewWithoutDefaults

func NewWithoutDefaults(endpoint string) BaseClient

NewWithoutDefaults creates an instance of the BaseClient client.

type BasicAnswer

type BasicAnswer interface {
	AsNews() (*News, bool)
	AsSearchResultsAnswer() (*SearchResultsAnswer, bool)
	AsBasicSearchResultsAnswer() (BasicSearchResultsAnswer, bool)
	AsTrendingTopics() (*TrendingTopics, bool)
	AsAnswer() (*Answer, bool)
}

BasicAnswer defines an answer.

type BasicArticle

type BasicArticle interface {
	AsNewsArticle() (*NewsArticle, bool)
	AsArticle() (*Article, bool)
}

BasicArticle ...

type BasicCreativeWork

type BasicCreativeWork interface {
	AsNewsArticle() (*NewsArticle, bool)
	AsImageObject() (*ImageObject, bool)
	AsArticle() (*Article, bool)
	AsBasicArticle() (BasicArticle, bool)
	AsVideoObject() (*VideoObject, bool)
	AsMediaObject() (*MediaObject, bool)
	AsBasicMediaObject() (BasicMediaObject, bool)
	AsCreativeWork() (*CreativeWork, bool)
}

BasicCreativeWork the most generic kind of creative work, including books, movies, photographs, software programs, etc.

type BasicIdentifiable

type BasicIdentifiable interface {
	AsNewsArticle() (*NewsArticle, bool)
	AsNews() (*News, bool)
	AsSearchResultsAnswer() (*SearchResultsAnswer, bool)
	AsBasicSearchResultsAnswer() (BasicSearchResultsAnswer, bool)
	AsImageObject() (*ImageObject, bool)
	AsNewsTopic() (*NewsTopic, bool)
	AsAnswer() (*Answer, bool)
	AsBasicAnswer() (BasicAnswer, bool)
	AsArticle() (*Article, bool)
	AsBasicArticle() (BasicArticle, bool)
	AsThing() (*Thing, bool)
	AsBasicThing() (BasicThing, bool)
	AsResponse() (*Response, bool)
	AsBasicResponse() (BasicResponse, bool)
	AsTrendingTopics() (*TrendingTopics, bool)
	AsVideoObject() (*VideoObject, bool)
	AsCreativeWork() (*CreativeWork, bool)
	AsBasicCreativeWork() (BasicCreativeWork, bool)
	AsOrganization() (*Organization, bool)
	AsErrorResponse() (*ErrorResponse, bool)
	AsMediaObject() (*MediaObject, bool)
	AsBasicMediaObject() (BasicMediaObject, bool)
	AsIdentifiable() (*Identifiable, bool)
}

BasicIdentifiable defines the identity of a resource.

type BasicMediaObject

type BasicMediaObject interface {
	AsImageObject() (*ImageObject, bool)
	AsVideoObject() (*VideoObject, bool)
	AsMediaObject() (*MediaObject, bool)
}

BasicMediaObject defines a media object.

type BasicResponse

type BasicResponse interface {
	AsNewsArticle() (*NewsArticle, bool)
	AsNews() (*News, bool)
	AsSearchResultsAnswer() (*SearchResultsAnswer, bool)
	AsBasicSearchResultsAnswer() (BasicSearchResultsAnswer, bool)
	AsImageObject() (*ImageObject, bool)
	AsNewsTopic() (*NewsTopic, bool)
	AsAnswer() (*Answer, bool)
	AsBasicAnswer() (BasicAnswer, bool)
	AsArticle() (*Article, bool)
	AsBasicArticle() (BasicArticle, bool)
	AsThing() (*Thing, bool)
	AsBasicThing() (BasicThing, bool)
	AsTrendingTopics() (*TrendingTopics, bool)
	AsVideoObject() (*VideoObject, bool)
	AsCreativeWork() (*CreativeWork, bool)
	AsBasicCreativeWork() (BasicCreativeWork, bool)
	AsOrganization() (*Organization, bool)
	AsErrorResponse() (*ErrorResponse, bool)
	AsMediaObject() (*MediaObject, bool)
	AsBasicMediaObject() (BasicMediaObject, bool)
	AsResponse() (*Response, bool)
}

BasicResponse defines a response. All schemas that could be returned at the root of a response should inherit from this

type BasicResponseBase

type BasicResponseBase interface {
	AsNewsArticle() (*NewsArticle, bool)
	AsNews() (*News, bool)
	AsSearchResultsAnswer() (*SearchResultsAnswer, bool)
	AsBasicSearchResultsAnswer() (BasicSearchResultsAnswer, bool)
	AsImageObject() (*ImageObject, bool)
	AsNewsTopic() (*NewsTopic, bool)
	AsAnswer() (*Answer, bool)
	AsBasicAnswer() (BasicAnswer, bool)
	AsArticle() (*Article, bool)
	AsBasicArticle() (BasicArticle, bool)
	AsThing() (*Thing, bool)
	AsBasicThing() (BasicThing, bool)
	AsResponse() (*Response, bool)
	AsBasicResponse() (BasicResponse, bool)
	AsTrendingTopics() (*TrendingTopics, bool)
	AsVideoObject() (*VideoObject, bool)
	AsCreativeWork() (*CreativeWork, bool)
	AsBasicCreativeWork() (BasicCreativeWork, bool)
	AsOrganization() (*Organization, bool)
	AsIdentifiable() (*Identifiable, bool)
	AsBasicIdentifiable() (BasicIdentifiable, bool)
	AsErrorResponse() (*ErrorResponse, bool)
	AsMediaObject() (*MediaObject, bool)
	AsBasicMediaObject() (BasicMediaObject, bool)
	AsResponseBase() (*ResponseBase, bool)
}

BasicResponseBase response base

type BasicSearchResultsAnswer

type BasicSearchResultsAnswer interface {
	AsNews() (*News, bool)
	AsSearchResultsAnswer() (*SearchResultsAnswer, bool)
}

BasicSearchResultsAnswer defines a search result answer.

type BasicThing

type BasicThing interface {
	AsNewsArticle() (*NewsArticle, bool)
	AsImageObject() (*ImageObject, bool)
	AsNewsTopic() (*NewsTopic, bool)
	AsArticle() (*Article, bool)
	AsBasicArticle() (BasicArticle, bool)
	AsVideoObject() (*VideoObject, bool)
	AsCreativeWork() (*CreativeWork, bool)
	AsBasicCreativeWork() (BasicCreativeWork, bool)
	AsOrganization() (*Organization, bool)
	AsMediaObject() (*MediaObject, bool)
	AsBasicMediaObject() (BasicMediaObject, bool)
	AsThing() (*Thing, bool)
}

BasicThing defines a thing.

type CreativeWork

type CreativeWork struct {
	// ThumbnailURL - The URL to a thumbnail of the item.
	ThumbnailURL *string `json:"thumbnailUrl,omitempty"`
	// Provider - The source of the creative work.
	Provider *[]BasicThing `json:"provider,omitempty"`
	// DatePublished - The date on which the CreativeWork was published.
	DatePublished *string `json:"datePublished,omitempty"`
	// Video - A video of the item.
	Video *VideoObject `json:"video,omitempty"`
	// Name - The name of the thing represented by this object.
	Name *string `json:"name,omitempty"`
	// URL - The URL to get more information about the thing represented by this object.
	URL *string `json:"url,omitempty"`
	// Image - An image of the item.
	Image *ImageObject `json:"image,omitempty"`
	// Description - A short description of the item.
	Description *string `json:"description,omitempty"`
	// AlternateName - An alias for the item
	AlternateName *string `json:"alternateName,omitempty"`
	// BingID - An ID that uniquely identifies this item.
	BingID *string `json:"bingId,omitempty"`
	// WebSearchURL - The URL To Bing's search result for this item.
	WebSearchURL *string `json:"webSearchUrl,omitempty"`
	// ID - A String identifier.
	ID *string `json:"id,omitempty"`
	// Type - Possible values include: 'TypeResponseBase', 'TypeNewsArticle', 'TypeNews', 'TypeSearchResultsAnswer', 'TypeImageObject', 'TypeNewsTopic', 'TypeAnswer', 'TypeArticle', 'TypeThing', 'TypeResponse', 'TypeTrendingTopics', 'TypeVideoObject', 'TypeCreativeWork', 'TypeOrganization', 'TypeIdentifiable', 'TypeErrorResponse', 'TypeMediaObject'
	Type Type `json:"_type,omitempty"`
}

CreativeWork the most generic kind of creative work, including books, movies, photographs, software programs, etc.

func (CreativeWork) AsAnswer

func (cw CreativeWork) AsAnswer() (*Answer, bool)

AsAnswer is the BasicResponseBase implementation for CreativeWork.

func (CreativeWork) AsArticle

func (cw CreativeWork) AsArticle() (*Article, bool)

AsArticle is the BasicResponseBase implementation for CreativeWork.

func (CreativeWork) AsBasicAnswer

func (cw CreativeWork) AsBasicAnswer() (BasicAnswer, bool)

AsBasicAnswer is the BasicResponseBase implementation for CreativeWork.

func (CreativeWork) AsBasicArticle

func (cw CreativeWork) AsBasicArticle() (BasicArticle, bool)

AsBasicArticle is the BasicResponseBase implementation for CreativeWork.

func (CreativeWork) AsBasicCreativeWork

func (cw CreativeWork) AsBasicCreativeWork() (BasicCreativeWork, bool)

AsBasicCreativeWork is the BasicResponseBase implementation for CreativeWork.

func (CreativeWork) AsBasicIdentifiable

func (cw CreativeWork) AsBasicIdentifiable() (BasicIdentifiable, bool)

AsBasicIdentifiable is the BasicResponseBase implementation for CreativeWork.

func (CreativeWork) AsBasicMediaObject

func (cw CreativeWork) AsBasicMediaObject() (BasicMediaObject, bool)

AsBasicMediaObject is the BasicResponseBase implementation for CreativeWork.

func (CreativeWork) AsBasicResponse

func (cw CreativeWork) AsBasicResponse() (BasicResponse, bool)

AsBasicResponse is the BasicResponseBase implementation for CreativeWork.

func (CreativeWork) AsBasicResponseBase

func (cw CreativeWork) AsBasicResponseBase() (BasicResponseBase, bool)

AsBasicResponseBase is the BasicResponseBase implementation for CreativeWork.

func (CreativeWork) AsBasicSearchResultsAnswer

func (cw CreativeWork) AsBasicSearchResultsAnswer() (BasicSearchResultsAnswer, bool)

AsBasicSearchResultsAnswer is the BasicResponseBase implementation for CreativeWork.

func (CreativeWork) AsBasicThing

func (cw CreativeWork) AsBasicThing() (BasicThing, bool)

AsBasicThing is the BasicResponseBase implementation for CreativeWork.

func (CreativeWork) AsCreativeWork

func (cw CreativeWork) AsCreativeWork() (*CreativeWork, bool)

AsCreativeWork is the BasicResponseBase implementation for CreativeWork.

func (CreativeWork) AsErrorResponse

func (cw CreativeWork) AsErrorResponse() (*ErrorResponse, bool)

AsErrorResponse is the BasicResponseBase implementation for CreativeWork.

func (CreativeWork) AsIdentifiable

func (cw CreativeWork) AsIdentifiable() (*Identifiable, bool)

AsIdentifiable is the BasicResponseBase implementation for CreativeWork.

func (CreativeWork) AsImageObject

func (cw CreativeWork) AsImageObject() (*ImageObject, bool)

AsImageObject is the BasicResponseBase implementation for CreativeWork.

func (CreativeWork) AsMediaObject

func (cw CreativeWork) AsMediaObject() (*MediaObject, bool)

AsMediaObject is the BasicResponseBase implementation for CreativeWork.

func (CreativeWork) AsNews

func (cw CreativeWork) AsNews() (*News, bool)

AsNews is the BasicResponseBase implementation for CreativeWork.

func (CreativeWork) AsNewsArticle

func (cw CreativeWork) AsNewsArticle() (*NewsArticle, bool)

AsNewsArticle is the BasicResponseBase implementation for CreativeWork.

func (CreativeWork) AsNewsTopic

func (cw CreativeWork) AsNewsTopic() (*NewsTopic, bool)

AsNewsTopic is the BasicResponseBase implementation for CreativeWork.

func (CreativeWork) AsOrganization

func (cw CreativeWork) AsOrganization() (*Organization, bool)

AsOrganization is the BasicResponseBase implementation for CreativeWork.

func (CreativeWork) AsResponse

func (cw CreativeWork) AsResponse() (*Response, bool)

AsResponse is the BasicResponseBase implementation for CreativeWork.

func (CreativeWork) AsResponseBase

func (cw CreativeWork) AsResponseBase() (*ResponseBase, bool)

AsResponseBase is the BasicResponseBase implementation for CreativeWork.

func (CreativeWork) AsSearchResultsAnswer

func (cw CreativeWork) AsSearchResultsAnswer() (*SearchResultsAnswer, bool)

AsSearchResultsAnswer is the BasicResponseBase implementation for CreativeWork.

func (CreativeWork) AsThing

func (cw CreativeWork) AsThing() (*Thing, bool)

AsThing is the BasicResponseBase implementation for CreativeWork.

func (CreativeWork) AsTrendingTopics

func (cw CreativeWork) AsTrendingTopics() (*TrendingTopics, bool)

AsTrendingTopics is the BasicResponseBase implementation for CreativeWork.

func (CreativeWork) AsVideoObject

func (cw CreativeWork) AsVideoObject() (*VideoObject, bool)

AsVideoObject is the BasicResponseBase implementation for CreativeWork.

func (CreativeWork) MarshalJSON

func (cw CreativeWork) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for CreativeWork.

func (*CreativeWork) UnmarshalJSON

func (cw *CreativeWork) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for CreativeWork struct.

type Error

type Error struct {
	// Code - The error code that identifies the category of error. Possible values include: 'None', 'ServerError', 'InvalidRequest', 'RateLimitExceeded', 'InvalidAuthorization', 'InsufficientAuthorization'
	Code ErrorCode `json:"code,omitempty"`
	// SubCode - The error code that further helps to identify the error. Possible values include: 'UnexpectedError', 'ResourceError', 'NotImplemented', 'ParameterMissing', 'ParameterInvalidValue', 'HTTPNotAllowed', 'Blocked', 'AuthorizationMissing', 'AuthorizationRedundancy', 'AuthorizationDisabled', 'AuthorizationExpired'
	SubCode ErrorSubCode `json:"subCode,omitempty"`
	// Message - A description of the error.
	Message *string `json:"message,omitempty"`
	// MoreDetails - A description that provides additional information about the error.
	MoreDetails *string `json:"moreDetails,omitempty"`
	// Parameter - The parameter in the request that caused the error.
	Parameter *string `json:"parameter,omitempty"`
	// Value - The parameter's value in the request that was not valid.
	Value *string `json:"value,omitempty"`
}

Error defines the error that occurred.

type ErrorCode

type ErrorCode string

ErrorCode enumerates the values for error code.

const (
	// InsufficientAuthorization ...
	InsufficientAuthorization ErrorCode = "InsufficientAuthorization"
	// InvalidAuthorization ...
	InvalidAuthorization ErrorCode = "InvalidAuthorization"
	// InvalidRequest ...
	InvalidRequest ErrorCode = "InvalidRequest"
	// None ...
	None ErrorCode = "None"
	// RateLimitExceeded ...
	RateLimitExceeded ErrorCode = "RateLimitExceeded"
	// ServerError ...
	ServerError ErrorCode = "ServerError"
)

func PossibleErrorCodeValues

func PossibleErrorCodeValues() []ErrorCode

PossibleErrorCodeValues returns an array of possible values for the ErrorCode const type.

type ErrorResponse

type ErrorResponse struct {
	// Errors - A list of errors that describe the reasons why the request failed.
	Errors *[]Error `json:"errors,omitempty"`
	// WebSearchURL - The URL To Bing's search result for this item.
	WebSearchURL *string `json:"webSearchUrl,omitempty"`
	// ID - A String identifier.
	ID *string `json:"id,omitempty"`
	// Type - Possible values include: 'TypeResponseBase', 'TypeNewsArticle', 'TypeNews', 'TypeSearchResultsAnswer', 'TypeImageObject', 'TypeNewsTopic', 'TypeAnswer', 'TypeArticle', 'TypeThing', 'TypeResponse', 'TypeTrendingTopics', 'TypeVideoObject', 'TypeCreativeWork', 'TypeOrganization', 'TypeIdentifiable', 'TypeErrorResponse', 'TypeMediaObject'
	Type Type `json:"_type,omitempty"`
}

ErrorResponse the top-level response that represents a failed request.

func (ErrorResponse) AsAnswer

func (er ErrorResponse) AsAnswer() (*Answer, bool)

AsAnswer is the BasicResponseBase implementation for ErrorResponse.

func (ErrorResponse) AsArticle

func (er ErrorResponse) AsArticle() (*Article, bool)

AsArticle is the BasicResponseBase implementation for ErrorResponse.

func (ErrorResponse) AsBasicAnswer

func (er ErrorResponse) AsBasicAnswer() (BasicAnswer, bool)

AsBasicAnswer is the BasicResponseBase implementation for ErrorResponse.

func (ErrorResponse) AsBasicArticle

func (er ErrorResponse) AsBasicArticle() (BasicArticle, bool)

AsBasicArticle is the BasicResponseBase implementation for ErrorResponse.

func (ErrorResponse) AsBasicCreativeWork

func (er ErrorResponse) AsBasicCreativeWork() (BasicCreativeWork, bool)

AsBasicCreativeWork is the BasicResponseBase implementation for ErrorResponse.

func (ErrorResponse) AsBasicIdentifiable

func (er ErrorResponse) AsBasicIdentifiable() (BasicIdentifiable, bool)

AsBasicIdentifiable is the BasicResponseBase implementation for ErrorResponse.

func (ErrorResponse) AsBasicMediaObject

func (er ErrorResponse) AsBasicMediaObject() (BasicMediaObject, bool)

AsBasicMediaObject is the BasicResponseBase implementation for ErrorResponse.

func (ErrorResponse) AsBasicResponse

func (er ErrorResponse) AsBasicResponse() (BasicResponse, bool)

AsBasicResponse is the BasicResponseBase implementation for ErrorResponse.

func (ErrorResponse) AsBasicResponseBase

func (er ErrorResponse) AsBasicResponseBase() (BasicResponseBase, bool)

AsBasicResponseBase is the BasicResponseBase implementation for ErrorResponse.

func (ErrorResponse) AsBasicSearchResultsAnswer

func (er ErrorResponse) AsBasicSearchResultsAnswer() (BasicSearchResultsAnswer, bool)

AsBasicSearchResultsAnswer is the BasicResponseBase implementation for ErrorResponse.

func (ErrorResponse) AsBasicThing

func (er ErrorResponse) AsBasicThing() (BasicThing, bool)

AsBasicThing is the BasicResponseBase implementation for ErrorResponse.

func (ErrorResponse) AsCreativeWork

func (er ErrorResponse) AsCreativeWork() (*CreativeWork, bool)

AsCreativeWork is the BasicResponseBase implementation for ErrorResponse.

func (ErrorResponse) AsErrorResponse

func (er ErrorResponse) AsErrorResponse() (*ErrorResponse, bool)

AsErrorResponse is the BasicResponseBase implementation for ErrorResponse.

func (ErrorResponse) AsIdentifiable

func (er ErrorResponse) AsIdentifiable() (*Identifiable, bool)

AsIdentifiable is the BasicResponseBase implementation for ErrorResponse.

func (ErrorResponse) AsImageObject

func (er ErrorResponse) AsImageObject() (*ImageObject, bool)

AsImageObject is the BasicResponseBase implementation for ErrorResponse.

func (ErrorResponse) AsMediaObject

func (er ErrorResponse) AsMediaObject() (*MediaObject, bool)

AsMediaObject is the BasicResponseBase implementation for ErrorResponse.

func (ErrorResponse) AsNews

func (er ErrorResponse) AsNews() (*News, bool)

AsNews is the BasicResponseBase implementation for ErrorResponse.

func (ErrorResponse) AsNewsArticle

func (er ErrorResponse) AsNewsArticle() (*NewsArticle, bool)

AsNewsArticle is the BasicResponseBase implementation for ErrorResponse.

func (ErrorResponse) AsNewsTopic

func (er ErrorResponse) AsNewsTopic() (*NewsTopic, bool)

AsNewsTopic is the BasicResponseBase implementation for ErrorResponse.

func (ErrorResponse) AsOrganization

func (er ErrorResponse) AsOrganization() (*Organization, bool)

AsOrganization is the BasicResponseBase implementation for ErrorResponse.

func (ErrorResponse) AsResponse

func (er ErrorResponse) AsResponse() (*Response, bool)

AsResponse is the BasicResponseBase implementation for ErrorResponse.

func (ErrorResponse) AsResponseBase

func (er ErrorResponse) AsResponseBase() (*ResponseBase, bool)

AsResponseBase is the BasicResponseBase implementation for ErrorResponse.

func (ErrorResponse) AsSearchResultsAnswer

func (er ErrorResponse) AsSearchResultsAnswer() (*SearchResultsAnswer, bool)

AsSearchResultsAnswer is the BasicResponseBase implementation for ErrorResponse.

func (ErrorResponse) AsThing

func (er ErrorResponse) AsThing() (*Thing, bool)

AsThing is the BasicResponseBase implementation for ErrorResponse.

func (ErrorResponse) AsTrendingTopics

func (er ErrorResponse) AsTrendingTopics() (*TrendingTopics, bool)

AsTrendingTopics is the BasicResponseBase implementation for ErrorResponse.

func (ErrorResponse) AsVideoObject

func (er ErrorResponse) AsVideoObject() (*VideoObject, bool)

AsVideoObject is the BasicResponseBase implementation for ErrorResponse.

func (ErrorResponse) MarshalJSON

func (er ErrorResponse) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for ErrorResponse.

type ErrorSubCode

type ErrorSubCode string

ErrorSubCode enumerates the values for error sub code.

const (
	// AuthorizationDisabled ...
	AuthorizationDisabled ErrorSubCode = "AuthorizationDisabled"
	// AuthorizationExpired ...
	AuthorizationExpired ErrorSubCode = "AuthorizationExpired"
	// AuthorizationMissing ...
	AuthorizationMissing ErrorSubCode = "AuthorizationMissing"
	// AuthorizationRedundancy ...
	AuthorizationRedundancy ErrorSubCode = "AuthorizationRedundancy"
	// Blocked ...
	Blocked ErrorSubCode = "Blocked"
	// HTTPNotAllowed ...
	HTTPNotAllowed ErrorSubCode = "HttpNotAllowed"
	// NotImplemented ...
	NotImplemented ErrorSubCode = "NotImplemented"
	// ParameterInvalidValue ...
	ParameterInvalidValue ErrorSubCode = "ParameterInvalidValue"
	// ParameterMissing ...
	ParameterMissing ErrorSubCode = "ParameterMissing"
	// ResourceError ...
	ResourceError ErrorSubCode = "ResourceError"
	// UnexpectedError ...
	UnexpectedError ErrorSubCode = "UnexpectedError"
)

func PossibleErrorSubCodeValues

func PossibleErrorSubCodeValues() []ErrorSubCode

PossibleErrorSubCodeValues returns an array of possible values for the ErrorSubCode const type.

type Freshness

type Freshness string

Freshness enumerates the values for freshness.

const (
	// Day ...
	Day Freshness = "Day"
	// Month ...
	Month Freshness = "Month"
	// Week ...
	Week Freshness = "Week"
)

func PossibleFreshnessValues

func PossibleFreshnessValues() []Freshness

PossibleFreshnessValues returns an array of possible values for the Freshness const type.

type Identifiable

type Identifiable struct {
	// ID - A String identifier.
	ID *string `json:"id,omitempty"`
	// Type - Possible values include: 'TypeResponseBase', 'TypeNewsArticle', 'TypeNews', 'TypeSearchResultsAnswer', 'TypeImageObject', 'TypeNewsTopic', 'TypeAnswer', 'TypeArticle', 'TypeThing', 'TypeResponse', 'TypeTrendingTopics', 'TypeVideoObject', 'TypeCreativeWork', 'TypeOrganization', 'TypeIdentifiable', 'TypeErrorResponse', 'TypeMediaObject'
	Type Type `json:"_type,omitempty"`
}

Identifiable defines the identity of a resource.

func (Identifiable) AsAnswer

func (i Identifiable) AsAnswer() (*Answer, bool)

AsAnswer is the BasicResponseBase implementation for Identifiable.

func (Identifiable) AsArticle

func (i Identifiable) AsArticle() (*Article, bool)

AsArticle is the BasicResponseBase implementation for Identifiable.

func (Identifiable) AsBasicAnswer

func (i Identifiable) AsBasicAnswer() (BasicAnswer, bool)

AsBasicAnswer is the BasicResponseBase implementation for Identifiable.

func (Identifiable) AsBasicArticle

func (i Identifiable) AsBasicArticle() (BasicArticle, bool)

AsBasicArticle is the BasicResponseBase implementation for Identifiable.

func (Identifiable) AsBasicCreativeWork

func (i Identifiable) AsBasicCreativeWork() (BasicCreativeWork, bool)

AsBasicCreativeWork is the BasicResponseBase implementation for Identifiable.

func (Identifiable) AsBasicIdentifiable

func (i Identifiable) AsBasicIdentifiable() (BasicIdentifiable, bool)

AsBasicIdentifiable is the BasicResponseBase implementation for Identifiable.

func (Identifiable) AsBasicMediaObject

func (i Identifiable) AsBasicMediaObject() (BasicMediaObject, bool)

AsBasicMediaObject is the BasicResponseBase implementation for Identifiable.

func (Identifiable) AsBasicResponse

func (i Identifiable) AsBasicResponse() (BasicResponse, bool)

AsBasicResponse is the BasicResponseBase implementation for Identifiable.

func (Identifiable) AsBasicResponseBase

func (i Identifiable) AsBasicResponseBase() (BasicResponseBase, bool)

AsBasicResponseBase is the BasicResponseBase implementation for Identifiable.

func (Identifiable) AsBasicSearchResultsAnswer

func (i Identifiable) AsBasicSearchResultsAnswer() (BasicSearchResultsAnswer, bool)

AsBasicSearchResultsAnswer is the BasicResponseBase implementation for Identifiable.

func (Identifiable) AsBasicThing

func (i Identifiable) AsBasicThing() (BasicThing, bool)

AsBasicThing is the BasicResponseBase implementation for Identifiable.

func (Identifiable) AsCreativeWork

func (i Identifiable) AsCreativeWork() (*CreativeWork, bool)

AsCreativeWork is the BasicResponseBase implementation for Identifiable.

func (Identifiable) AsErrorResponse

func (i Identifiable) AsErrorResponse() (*ErrorResponse, bool)

AsErrorResponse is the BasicResponseBase implementation for Identifiable.

func (Identifiable) AsIdentifiable

func (i Identifiable) AsIdentifiable() (*Identifiable, bool)

AsIdentifiable is the BasicResponseBase implementation for Identifiable.

func (Identifiable) AsImageObject

func (i Identifiable) AsImageObject() (*ImageObject, bool)

AsImageObject is the BasicResponseBase implementation for Identifiable.

func (Identifiable) AsMediaObject

func (i Identifiable) AsMediaObject() (*MediaObject, bool)

AsMediaObject is the BasicResponseBase implementation for Identifiable.

func (Identifiable) AsNews

func (i Identifiable) AsNews() (*News, bool)

AsNews is the BasicResponseBase implementation for Identifiable.

func (Identifiable) AsNewsArticle

func (i Identifiable) AsNewsArticle() (*NewsArticle, bool)

AsNewsArticle is the BasicResponseBase implementation for Identifiable.

func (Identifiable) AsNewsTopic

func (i Identifiable) AsNewsTopic() (*NewsTopic, bool)

AsNewsTopic is the BasicResponseBase implementation for Identifiable.

func (Identifiable) AsOrganization

func (i Identifiable) AsOrganization() (*Organization, bool)

AsOrganization is the BasicResponseBase implementation for Identifiable.

func (Identifiable) AsResponse

func (i Identifiable) AsResponse() (*Response, bool)

AsResponse is the BasicResponseBase implementation for Identifiable.

func (Identifiable) AsResponseBase

func (i Identifiable) AsResponseBase() (*ResponseBase, bool)

AsResponseBase is the BasicResponseBase implementation for Identifiable.

func (Identifiable) AsSearchResultsAnswer

func (i Identifiable) AsSearchResultsAnswer() (*SearchResultsAnswer, bool)

AsSearchResultsAnswer is the BasicResponseBase implementation for Identifiable.

func (Identifiable) AsThing

func (i Identifiable) AsThing() (*Thing, bool)

AsThing is the BasicResponseBase implementation for Identifiable.

func (Identifiable) AsTrendingTopics

func (i Identifiable) AsTrendingTopics() (*TrendingTopics, bool)

AsTrendingTopics is the BasicResponseBase implementation for Identifiable.

func (Identifiable) AsVideoObject

func (i Identifiable) AsVideoObject() (*VideoObject, bool)

AsVideoObject is the BasicResponseBase implementation for Identifiable.

func (Identifiable) MarshalJSON

func (i Identifiable) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for Identifiable.

type ImageObject

type ImageObject struct {
	// Thumbnail - The URL to a thumbnail of the image
	Thumbnail *ImageObject `json:"thumbnail,omitempty"`
	// ContentURL - Original URL to retrieve the source (file) for the media object (e.g the source URL for the image).
	ContentURL *string `json:"contentUrl,omitempty"`
	// Width - The width of the source media object, in pixels.
	Width *int32 `json:"width,omitempty"`
	// Height - The height of the source media object, in pixels.
	Height *int32 `json:"height,omitempty"`
	// ThumbnailURL - The URL to a thumbnail of the item.
	ThumbnailURL *string `json:"thumbnailUrl,omitempty"`
	// Provider - The source of the creative work.
	Provider *[]BasicThing `json:"provider,omitempty"`
	// DatePublished - The date on which the CreativeWork was published.
	DatePublished *string `json:"datePublished,omitempty"`
	// Video - A video of the item.
	Video *VideoObject `json:"video,omitempty"`
	// Name - The name of the thing represented by this object.
	Name *string `json:"name,omitempty"`
	// URL - The URL to get more information about the thing represented by this object.
	URL *string `json:"url,omitempty"`
	// Image - An image of the item.
	Image *ImageObject `json:"image,omitempty"`
	// Description - A short description of the item.
	Description *string `json:"description,omitempty"`
	// AlternateName - An alias for the item
	AlternateName *string `json:"alternateName,omitempty"`
	// BingID - An ID that uniquely identifies this item.
	BingID *string `json:"bingId,omitempty"`
	// WebSearchURL - The URL To Bing's search result for this item.
	WebSearchURL *string `json:"webSearchUrl,omitempty"`
	// ID - A String identifier.
	ID *string `json:"id,omitempty"`
	// Type - Possible values include: 'TypeResponseBase', 'TypeNewsArticle', 'TypeNews', 'TypeSearchResultsAnswer', 'TypeImageObject', 'TypeNewsTopic', 'TypeAnswer', 'TypeArticle', 'TypeThing', 'TypeResponse', 'TypeTrendingTopics', 'TypeVideoObject', 'TypeCreativeWork', 'TypeOrganization', 'TypeIdentifiable', 'TypeErrorResponse', 'TypeMediaObject'
	Type Type `json:"_type,omitempty"`
}

ImageObject defines an image

func (ImageObject) AsAnswer

func (ioVar ImageObject) AsAnswer() (*Answer, bool)

AsAnswer is the BasicResponseBase implementation for ImageObject.

func (ImageObject) AsArticle

func (ioVar ImageObject) AsArticle() (*Article, bool)

AsArticle is the BasicResponseBase implementation for ImageObject.

func (ImageObject) AsBasicAnswer

func (ioVar ImageObject) AsBasicAnswer() (BasicAnswer, bool)

AsBasicAnswer is the BasicResponseBase implementation for ImageObject.

func (ImageObject) AsBasicArticle

func (ioVar ImageObject) AsBasicArticle() (BasicArticle, bool)

AsBasicArticle is the BasicResponseBase implementation for ImageObject.

func (ImageObject) AsBasicCreativeWork

func (ioVar ImageObject) AsBasicCreativeWork() (BasicCreativeWork, bool)

AsBasicCreativeWork is the BasicResponseBase implementation for ImageObject.

func (ImageObject) AsBasicIdentifiable

func (ioVar ImageObject) AsBasicIdentifiable() (BasicIdentifiable, bool)

AsBasicIdentifiable is the BasicResponseBase implementation for ImageObject.

func (ImageObject) AsBasicMediaObject

func (ioVar ImageObject) AsBasicMediaObject() (BasicMediaObject, bool)

AsBasicMediaObject is the BasicResponseBase implementation for ImageObject.

func (ImageObject) AsBasicResponse

func (ioVar ImageObject) AsBasicResponse() (BasicResponse, bool)

AsBasicResponse is the BasicResponseBase implementation for ImageObject.

func (ImageObject) AsBasicResponseBase

func (ioVar ImageObject) AsBasicResponseBase() (BasicResponseBase, bool)

AsBasicResponseBase is the BasicResponseBase implementation for ImageObject.

func (ImageObject) AsBasicSearchResultsAnswer

func (ioVar ImageObject) AsBasicSearchResultsAnswer() (BasicSearchResultsAnswer, bool)

AsBasicSearchResultsAnswer is the BasicResponseBase implementation for ImageObject.

func (ImageObject) AsBasicThing

func (ioVar ImageObject) AsBasicThing() (BasicThing, bool)

AsBasicThing is the BasicResponseBase implementation for ImageObject.

func (ImageObject) AsCreativeWork

func (ioVar ImageObject) AsCreativeWork() (*CreativeWork, bool)

AsCreativeWork is the BasicResponseBase implementation for ImageObject.

func (ImageObject) AsErrorResponse

func (ioVar ImageObject) AsErrorResponse() (*ErrorResponse, bool)

AsErrorResponse is the BasicResponseBase implementation for ImageObject.

func (ImageObject) AsIdentifiable

func (ioVar ImageObject) AsIdentifiable() (*Identifiable, bool)

AsIdentifiable is the BasicResponseBase implementation for ImageObject.

func (ImageObject) AsImageObject

func (ioVar ImageObject) AsImageObject() (*ImageObject, bool)

AsImageObject is the BasicResponseBase implementation for ImageObject.

func (ImageObject) AsMediaObject

func (ioVar ImageObject) AsMediaObject() (*MediaObject, bool)

AsMediaObject is the BasicResponseBase implementation for ImageObject.

func (ImageObject) AsNews

func (ioVar ImageObject) AsNews() (*News, bool)

AsNews is the BasicResponseBase implementation for ImageObject.

func (ImageObject) AsNewsArticle

func (ioVar ImageObject) AsNewsArticle() (*NewsArticle, bool)

AsNewsArticle is the BasicResponseBase implementation for ImageObject.

func (ImageObject) AsNewsTopic

func (ioVar ImageObject) AsNewsTopic() (*NewsTopic, bool)

AsNewsTopic is the BasicResponseBase implementation for ImageObject.

func (ImageObject) AsOrganization

func (ioVar ImageObject) AsOrganization() (*Organization, bool)

AsOrganization is the BasicResponseBase implementation for ImageObject.

func (ImageObject) AsResponse

func (ioVar ImageObject) AsResponse() (*Response, bool)

AsResponse is the BasicResponseBase implementation for ImageObject.

func (ImageObject) AsResponseBase

func (ioVar ImageObject) AsResponseBase() (*ResponseBase, bool)

AsResponseBase is the BasicResponseBase implementation for ImageObject.

func (ImageObject) AsSearchResultsAnswer

func (ioVar ImageObject) AsSearchResultsAnswer() (*SearchResultsAnswer, bool)

AsSearchResultsAnswer is the BasicResponseBase implementation for ImageObject.

func (ImageObject) AsThing

func (ioVar ImageObject) AsThing() (*Thing, bool)

AsThing is the BasicResponseBase implementation for ImageObject.

func (ImageObject) AsTrendingTopics

func (ioVar ImageObject) AsTrendingTopics() (*TrendingTopics, bool)

AsTrendingTopics is the BasicResponseBase implementation for ImageObject.

func (ImageObject) AsVideoObject

func (ioVar ImageObject) AsVideoObject() (*VideoObject, bool)

AsVideoObject is the BasicResponseBase implementation for ImageObject.

func (ImageObject) MarshalJSON

func (ioVar ImageObject) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for ImageObject.

func (*ImageObject) UnmarshalJSON

func (ioVar *ImageObject) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for ImageObject struct.

type MediaObject

type MediaObject struct {
	// ContentURL - Original URL to retrieve the source (file) for the media object (e.g the source URL for the image).
	ContentURL *string `json:"contentUrl,omitempty"`
	// Width - The width of the source media object, in pixels.
	Width *int32 `json:"width,omitempty"`
	// Height - The height of the source media object, in pixels.
	Height *int32 `json:"height,omitempty"`
	// ThumbnailURL - The URL to a thumbnail of the item.
	ThumbnailURL *string `json:"thumbnailUrl,omitempty"`
	// Provider - The source of the creative work.
	Provider *[]BasicThing `json:"provider,omitempty"`
	// DatePublished - The date on which the CreativeWork was published.
	DatePublished *string `json:"datePublished,omitempty"`
	// Video - A video of the item.
	Video *VideoObject `json:"video,omitempty"`
	// Name - The name of the thing represented by this object.
	Name *string `json:"name,omitempty"`
	// URL - The URL to get more information about the thing represented by this object.
	URL *string `json:"url,omitempty"`
	// Image - An image of the item.
	Image *ImageObject `json:"image,omitempty"`
	// Description - A short description of the item.
	Description *string `json:"description,omitempty"`
	// AlternateName - An alias for the item
	AlternateName *string `json:"alternateName,omitempty"`
	// BingID - An ID that uniquely identifies this item.
	BingID *string `json:"bingId,omitempty"`
	// WebSearchURL - The URL To Bing's search result for this item.
	WebSearchURL *string `json:"webSearchUrl,omitempty"`
	// ID - A String identifier.
	ID *string `json:"id,omitempty"`
	// Type - Possible values include: 'TypeResponseBase', 'TypeNewsArticle', 'TypeNews', 'TypeSearchResultsAnswer', 'TypeImageObject', 'TypeNewsTopic', 'TypeAnswer', 'TypeArticle', 'TypeThing', 'TypeResponse', 'TypeTrendingTopics', 'TypeVideoObject', 'TypeCreativeWork', 'TypeOrganization', 'TypeIdentifiable', 'TypeErrorResponse', 'TypeMediaObject'
	Type Type `json:"_type,omitempty"`
}

MediaObject defines a media object.

func (MediaObject) AsAnswer

func (mo MediaObject) AsAnswer() (*Answer, bool)

AsAnswer is the BasicResponseBase implementation for MediaObject.

func (MediaObject) AsArticle

func (mo MediaObject) AsArticle() (*Article, bool)

AsArticle is the BasicResponseBase implementation for MediaObject.

func (MediaObject) AsBasicAnswer

func (mo MediaObject) AsBasicAnswer() (BasicAnswer, bool)

AsBasicAnswer is the BasicResponseBase implementation for MediaObject.

func (MediaObject) AsBasicArticle

func (mo MediaObject) AsBasicArticle() (BasicArticle, bool)

AsBasicArticle is the BasicResponseBase implementation for MediaObject.

func (MediaObject) AsBasicCreativeWork

func (mo MediaObject) AsBasicCreativeWork() (BasicCreativeWork, bool)

AsBasicCreativeWork is the BasicResponseBase implementation for MediaObject.

func (MediaObject) AsBasicIdentifiable

func (mo MediaObject) AsBasicIdentifiable() (BasicIdentifiable, bool)

AsBasicIdentifiable is the BasicResponseBase implementation for MediaObject.

func (MediaObject) AsBasicMediaObject

func (mo MediaObject) AsBasicMediaObject() (BasicMediaObject, bool)

AsBasicMediaObject is the BasicResponseBase implementation for MediaObject.

func (MediaObject) AsBasicResponse

func (mo MediaObject) AsBasicResponse() (BasicResponse, bool)

AsBasicResponse is the BasicResponseBase implementation for MediaObject.

func (MediaObject) AsBasicResponseBase

func (mo MediaObject) AsBasicResponseBase() (BasicResponseBase, bool)

AsBasicResponseBase is the BasicResponseBase implementation for MediaObject.

func (MediaObject) AsBasicSearchResultsAnswer

func (mo MediaObject) AsBasicSearchResultsAnswer() (BasicSearchResultsAnswer, bool)

AsBasicSearchResultsAnswer is the BasicResponseBase implementation for MediaObject.

func (MediaObject) AsBasicThing

func (mo MediaObject) AsBasicThing() (BasicThing, bool)

AsBasicThing is the BasicResponseBase implementation for MediaObject.

func (MediaObject) AsCreativeWork

func (mo MediaObject) AsCreativeWork() (*CreativeWork, bool)

AsCreativeWork is the BasicResponseBase implementation for MediaObject.

func (MediaObject) AsErrorResponse

func (mo MediaObject) AsErrorResponse() (*ErrorResponse, bool)

AsErrorResponse is the BasicResponseBase implementation for MediaObject.

func (MediaObject) AsIdentifiable

func (mo MediaObject) AsIdentifiable() (*Identifiable, bool)

AsIdentifiable is the BasicResponseBase implementation for MediaObject.

func (MediaObject) AsImageObject

func (mo MediaObject) AsImageObject() (*ImageObject, bool)

AsImageObject is the BasicResponseBase implementation for MediaObject.

func (MediaObject) AsMediaObject

func (mo MediaObject) AsMediaObject() (*MediaObject, bool)

AsMediaObject is the BasicResponseBase implementation for MediaObject.

func (MediaObject) AsNews

func (mo MediaObject) AsNews() (*News, bool)

AsNews is the BasicResponseBase implementation for MediaObject.

func (MediaObject) AsNewsArticle

func (mo MediaObject) AsNewsArticle() (*NewsArticle, bool)

AsNewsArticle is the BasicResponseBase implementation for MediaObject.

func (MediaObject) AsNewsTopic

func (mo MediaObject) AsNewsTopic() (*NewsTopic, bool)

AsNewsTopic is the BasicResponseBase implementation for MediaObject.

func (MediaObject) AsOrganization

func (mo MediaObject) AsOrganization() (*Organization, bool)

AsOrganization is the BasicResponseBase implementation for MediaObject.

func (MediaObject) AsResponse

func (mo MediaObject) AsResponse() (*Response, bool)

AsResponse is the BasicResponseBase implementation for MediaObject.

func (MediaObject) AsResponseBase

func (mo MediaObject) AsResponseBase() (*ResponseBase, bool)

AsResponseBase is the BasicResponseBase implementation for MediaObject.

func (MediaObject) AsSearchResultsAnswer

func (mo MediaObject) AsSearchResultsAnswer() (*SearchResultsAnswer, bool)

AsSearchResultsAnswer is the BasicResponseBase implementation for MediaObject.

func (MediaObject) AsThing

func (mo MediaObject) AsThing() (*Thing, bool)

AsThing is the BasicResponseBase implementation for MediaObject.

func (MediaObject) AsTrendingTopics

func (mo MediaObject) AsTrendingTopics() (*TrendingTopics, bool)

AsTrendingTopics is the BasicResponseBase implementation for MediaObject.

func (MediaObject) AsVideoObject

func (mo MediaObject) AsVideoObject() (*VideoObject, bool)

AsVideoObject is the BasicResponseBase implementation for MediaObject.

func (MediaObject) MarshalJSON

func (mo MediaObject) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for MediaObject.

func (*MediaObject) UnmarshalJSON

func (mo *MediaObject) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for MediaObject struct.

type News

type News struct {
	autorest.Response `json:"-"`
	// Value - An array of NewsArticle objects that contain information about news articles that are relevant to the query. If there are no results to return for the request, the array is empty.
	Value *[]NewsArticle `json:"value,omitempty"`
	// Location - Location of local news
	Location *string `json:"location,omitempty"`
	// TotalEstimatedMatches - The estimated number of webpages that are relevant to the query. Use this number along with the count and offset query parameters to page the results.
	TotalEstimatedMatches *int64   `json:"totalEstimatedMatches,omitempty"`
	FollowUpQueries       *[]Query `json:"followUpQueries,omitempty"`
	// WebSearchURL - The URL To Bing's search result for this item.
	WebSearchURL *string `json:"webSearchUrl,omitempty"`
	// ID - A String identifier.
	ID *string `json:"id,omitempty"`
	// Type - Possible values include: 'TypeResponseBase', 'TypeNewsArticle', 'TypeNews', 'TypeSearchResultsAnswer', 'TypeImageObject', 'TypeNewsTopic', 'TypeAnswer', 'TypeArticle', 'TypeThing', 'TypeResponse', 'TypeTrendingTopics', 'TypeVideoObject', 'TypeCreativeWork', 'TypeOrganization', 'TypeIdentifiable', 'TypeErrorResponse', 'TypeMediaObject'
	Type Type `json:"_type,omitempty"`
}

News defines a news answer.

func (News) AsAnswer

func (n News) AsAnswer() (*Answer, bool)

AsAnswer is the BasicResponseBase implementation for News.

func (News) AsArticle

func (n News) AsArticle() (*Article, bool)

AsArticle is the BasicResponseBase implementation for News.

func (News) AsBasicAnswer

func (n News) AsBasicAnswer() (BasicAnswer, bool)

AsBasicAnswer is the BasicResponseBase implementation for News.

func (News) AsBasicArticle

func (n News) AsBasicArticle() (BasicArticle, bool)

AsBasicArticle is the BasicResponseBase implementation for News.

func (News) AsBasicCreativeWork

func (n News) AsBasicCreativeWork() (BasicCreativeWork, bool)

AsBasicCreativeWork is the BasicResponseBase implementation for News.

func (News) AsBasicIdentifiable

func (n News) AsBasicIdentifiable() (BasicIdentifiable, bool)

AsBasicIdentifiable is the BasicResponseBase implementation for News.

func (News) AsBasicMediaObject

func (n News) AsBasicMediaObject() (BasicMediaObject, bool)

AsBasicMediaObject is the BasicResponseBase implementation for News.

func (News) AsBasicResponse

func (n News) AsBasicResponse() (BasicResponse, bool)

AsBasicResponse is the BasicResponseBase implementation for News.

func (News) AsBasicResponseBase

func (n News) AsBasicResponseBase() (BasicResponseBase, bool)

AsBasicResponseBase is the BasicResponseBase implementation for News.

func (News) AsBasicSearchResultsAnswer

func (n News) AsBasicSearchResultsAnswer() (BasicSearchResultsAnswer, bool)

AsBasicSearchResultsAnswer is the BasicResponseBase implementation for News.

func (News) AsBasicThing

func (n News) AsBasicThing() (BasicThing, bool)

AsBasicThing is the BasicResponseBase implementation for News.

func (News) AsCreativeWork

func (n News) AsCreativeWork() (*CreativeWork, bool)

AsCreativeWork is the BasicResponseBase implementation for News.

func (News) AsErrorResponse

func (n News) AsErrorResponse() (*ErrorResponse, bool)

AsErrorResponse is the BasicResponseBase implementation for News.

func (News) AsIdentifiable

func (n News) AsIdentifiable() (*Identifiable, bool)

AsIdentifiable is the BasicResponseBase implementation for News.

func (News) AsImageObject

func (n News) AsImageObject() (*ImageObject, bool)

AsImageObject is the BasicResponseBase implementation for News.

func (News) AsMediaObject

func (n News) AsMediaObject() (*MediaObject, bool)

AsMediaObject is the BasicResponseBase implementation for News.

func (News) AsNews

func (n News) AsNews() (*News, bool)

AsNews is the BasicResponseBase implementation for News.

func (News) AsNewsArticle

func (n News) AsNewsArticle() (*NewsArticle, bool)

AsNewsArticle is the BasicResponseBase implementation for News.

func (News) AsNewsTopic

func (n News) AsNewsTopic() (*NewsTopic, bool)

AsNewsTopic is the BasicResponseBase implementation for News.

func (News) AsOrganization

func (n News) AsOrganization() (*Organization, bool)

AsOrganization is the BasicResponseBase implementation for News.

func (News) AsResponse

func (n News) AsResponse() (*Response, bool)

AsResponse is the BasicResponseBase implementation for News.

func (News) AsResponseBase

func (n News) AsResponseBase() (*ResponseBase, bool)

AsResponseBase is the BasicResponseBase implementation for News.

func (News) AsSearchResultsAnswer

func (n News) AsSearchResultsAnswer() (*SearchResultsAnswer, bool)

AsSearchResultsAnswer is the BasicResponseBase implementation for News.

func (News) AsThing

func (n News) AsThing() (*Thing, bool)

AsThing is the BasicResponseBase implementation for News.

func (News) AsTrendingTopics

func (n News) AsTrendingTopics() (*TrendingTopics, bool)

AsTrendingTopics is the BasicResponseBase implementation for News.

func (News) AsVideoObject

func (n News) AsVideoObject() (*VideoObject, bool)

AsVideoObject is the BasicResponseBase implementation for News.

func (News) MarshalJSON

func (n News) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for News.

type NewsArticle

type NewsArticle struct {
	// Category - The news category that the article belongs to. For example, Sports. If the news category cannot be determined, the article does not include this field.
	Category *string `json:"category,omitempty"`
	// Headline - A Boolean value that indicates whether the news article is a headline. If true, the article is a headline. The article includes this field only for news categories requests that do not specify the category query parameter.
	Headline *bool `json:"headline,omitempty"`
	// ClusteredArticles - A list of related news articles.
	ClusteredArticles *[]NewsArticle `json:"clusteredArticles,omitempty"`
	// WordCount - The number of words in the text of the Article.
	WordCount *int32 `json:"wordCount,omitempty"`
	// ThumbnailURL - The URL to a thumbnail of the item.
	ThumbnailURL *string `json:"thumbnailUrl,omitempty"`
	// Provider - The source of the creative work.
	Provider *[]BasicThing `json:"provider,omitempty"`
	// DatePublished - The date on which the CreativeWork was published.
	DatePublished *string `json:"datePublished,omitempty"`
	// Video - A video of the item.
	Video *VideoObject `json:"video,omitempty"`
	// Name - The name of the thing represented by this object.
	Name *string `json:"name,omitempty"`
	// URL - The URL to get more information about the thing represented by this object.
	URL *string `json:"url,omitempty"`
	// Image - An image of the item.
	Image *ImageObject `json:"image,omitempty"`
	// Description - A short description of the item.
	Description *string `json:"description,omitempty"`
	// AlternateName - An alias for the item
	AlternateName *string `json:"alternateName,omitempty"`
	// BingID - An ID that uniquely identifies this item.
	BingID *string `json:"bingId,omitempty"`
	// WebSearchURL - The URL To Bing's search result for this item.
	WebSearchURL *string `json:"webSearchUrl,omitempty"`
	// ID - A String identifier.
	ID *string `json:"id,omitempty"`
	// Type - Possible values include: 'TypeResponseBase', 'TypeNewsArticle', 'TypeNews', 'TypeSearchResultsAnswer', 'TypeImageObject', 'TypeNewsTopic', 'TypeAnswer', 'TypeArticle', 'TypeThing', 'TypeResponse', 'TypeTrendingTopics', 'TypeVideoObject', 'TypeCreativeWork', 'TypeOrganization', 'TypeIdentifiable', 'TypeErrorResponse', 'TypeMediaObject'
	Type Type `json:"_type,omitempty"`
}

NewsArticle defines a news article.

func (NewsArticle) AsAnswer

func (na NewsArticle) AsAnswer() (*Answer, bool)

AsAnswer is the BasicResponseBase implementation for NewsArticle.

func (NewsArticle) AsArticle

func (na NewsArticle) AsArticle() (*Article, bool)

AsArticle is the BasicResponseBase implementation for NewsArticle.

func (NewsArticle) AsBasicAnswer

func (na NewsArticle) AsBasicAnswer() (BasicAnswer, bool)

AsBasicAnswer is the BasicResponseBase implementation for NewsArticle.

func (NewsArticle) AsBasicArticle

func (na NewsArticle) AsBasicArticle() (BasicArticle, bool)

AsBasicArticle is the BasicResponseBase implementation for NewsArticle.

func (NewsArticle) AsBasicCreativeWork

func (na NewsArticle) AsBasicCreativeWork() (BasicCreativeWork, bool)

AsBasicCreativeWork is the BasicResponseBase implementation for NewsArticle.

func (NewsArticle) AsBasicIdentifiable

func (na NewsArticle) AsBasicIdentifiable() (BasicIdentifiable, bool)

AsBasicIdentifiable is the BasicResponseBase implementation for NewsArticle.

func (NewsArticle) AsBasicMediaObject

func (na NewsArticle) AsBasicMediaObject() (BasicMediaObject, bool)

AsBasicMediaObject is the BasicResponseBase implementation for NewsArticle.

func (NewsArticle) AsBasicResponse

func (na NewsArticle) AsBasicResponse() (BasicResponse, bool)

AsBasicResponse is the BasicResponseBase implementation for NewsArticle.

func (NewsArticle) AsBasicResponseBase

func (na NewsArticle) AsBasicResponseBase() (BasicResponseBase, bool)

AsBasicResponseBase is the BasicResponseBase implementation for NewsArticle.

func (NewsArticle) AsBasicSearchResultsAnswer

func (na NewsArticle) AsBasicSearchResultsAnswer() (BasicSearchResultsAnswer, bool)

AsBasicSearchResultsAnswer is the BasicResponseBase implementation for NewsArticle.

func (NewsArticle) AsBasicThing

func (na NewsArticle) AsBasicThing() (BasicThing, bool)

AsBasicThing is the BasicResponseBase implementation for NewsArticle.

func (NewsArticle) AsCreativeWork

func (na NewsArticle) AsCreativeWork() (*CreativeWork, bool)

AsCreativeWork is the BasicResponseBase implementation for NewsArticle.

func (NewsArticle) AsErrorResponse

func (na NewsArticle) AsErrorResponse() (*ErrorResponse, bool)

AsErrorResponse is the BasicResponseBase implementation for NewsArticle.

func (NewsArticle) AsIdentifiable

func (na NewsArticle) AsIdentifiable() (*Identifiable, bool)

AsIdentifiable is the BasicResponseBase implementation for NewsArticle.

func (NewsArticle) AsImageObject

func (na NewsArticle) AsImageObject() (*ImageObject, bool)

AsImageObject is the BasicResponseBase implementation for NewsArticle.

func (NewsArticle) AsMediaObject

func (na NewsArticle) AsMediaObject() (*MediaObject, bool)

AsMediaObject is the BasicResponseBase implementation for NewsArticle.

func (NewsArticle) AsNews

func (na NewsArticle) AsNews() (*News, bool)

AsNews is the BasicResponseBase implementation for NewsArticle.

func (NewsArticle) AsNewsArticle

func (na NewsArticle) AsNewsArticle() (*NewsArticle, bool)

AsNewsArticle is the BasicResponseBase implementation for NewsArticle.

func (NewsArticle) AsNewsTopic

func (na NewsArticle) AsNewsTopic() (*NewsTopic, bool)

AsNewsTopic is the BasicResponseBase implementation for NewsArticle.

func (NewsArticle) AsOrganization

func (na NewsArticle) AsOrganization() (*Organization, bool)

AsOrganization is the BasicResponseBase implementation for NewsArticle.

func (NewsArticle) AsResponse

func (na NewsArticle) AsResponse() (*Response, bool)

AsResponse is the BasicResponseBase implementation for NewsArticle.

func (NewsArticle) AsResponseBase

func (na NewsArticle) AsResponseBase() (*ResponseBase, bool)

AsResponseBase is the BasicResponseBase implementation for NewsArticle.

func (NewsArticle) AsSearchResultsAnswer

func (na NewsArticle) AsSearchResultsAnswer() (*SearchResultsAnswer, bool)

AsSearchResultsAnswer is the BasicResponseBase implementation for NewsArticle.

func (NewsArticle) AsThing

func (na NewsArticle) AsThing() (*Thing, bool)

AsThing is the BasicResponseBase implementation for NewsArticle.

func (NewsArticle) AsTrendingTopics

func (na NewsArticle) AsTrendingTopics() (*TrendingTopics, bool)

AsTrendingTopics is the BasicResponseBase implementation for NewsArticle.

func (NewsArticle) AsVideoObject

func (na NewsArticle) AsVideoObject() (*VideoObject, bool)

AsVideoObject is the BasicResponseBase implementation for NewsArticle.

func (NewsArticle) MarshalJSON

func (na NewsArticle) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for NewsArticle.

func (*NewsArticle) UnmarshalJSON

func (na *NewsArticle) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for NewsArticle struct.

type NewsClient

type NewsClient struct {
	BaseClient
}

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).

func NewNewsClient

func NewNewsClient() NewsClient

NewNewsClient creates an instance of the NewsClient client.

func (NewsClient) Category

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)

Category sends the category request. Parameters: acceptLanguage - 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 - 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 - 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 - 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 - 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 - 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 - 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 - 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 - 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 - 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 - 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 - 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 - 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 - 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 - 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 - 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 &lt;).

func (NewsClient) CategoryPreparer

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)

CategoryPreparer prepares the Category request.

func (NewsClient) CategoryResponder

func (client NewsClient) CategoryResponder(resp *http.Response) (result News, err error)

CategoryResponder handles the response to the Category request. The method always closes the http.Response Body.

func (NewsClient) CategorySender

func (client NewsClient) CategorySender(req *http.Request) (*http.Response, error)

CategorySender sends the Category request. The method will close the http.Response Body if it receives an error.

func (NewsClient) Search

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)

Search sends the search request. Parameters: query - 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 - 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 - 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 - 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 - 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 - 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 - 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 - 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 - 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 - 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 - 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 - 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 - 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 - 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 - 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 - 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 - 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 &lt;).

func (NewsClient) SearchPreparer

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)

SearchPreparer prepares the Search request.

func (NewsClient) SearchResponder

func (client NewsClient) SearchResponder(resp *http.Response) (result News, err error)

SearchResponder handles the response to the Search request. The method always closes the http.Response Body.

func (NewsClient) SearchSender

func (client NewsClient) SearchSender(req *http.Request) (*http.Response, error)

SearchSender sends the Search request. The method will close the http.Response Body if it receives an error.

func (NewsClient) Trending

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)

Trending sends the trending request. Parameters: acceptLanguage - 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 - 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 - 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 - 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 - 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 - 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 - 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 - 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 - 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 - 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 - 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 - 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 - 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 - 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 - 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 &lt;).

func (NewsClient) TrendingPreparer

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)

TrendingPreparer prepares the Trending request.

func (NewsClient) TrendingResponder

func (client NewsClient) TrendingResponder(resp *http.Response) (result TrendingTopics, err error)

TrendingResponder handles the response to the Trending request. The method always closes the http.Response Body.

func (NewsClient) TrendingSender

func (client NewsClient) TrendingSender(req *http.Request) (*http.Response, error)

TrendingSender sends the Trending request. The method will close the http.Response Body if it receives an error.

type NewsTopic

type NewsTopic struct {
	// IsBreakingNews - A Boolean value that indicates whether the topic is considered breaking news. If the topic is considered breaking news, the value is true.
	IsBreakingNews *bool `json:"isBreakingNews,omitempty"`
	// Query - A search query term that returns this trending topic.
	Query *Query `json:"query,omitempty"`
	// NewsSearchURL - The URL to the Bing News search results for the search query term
	NewsSearchURL *string `json:"newsSearchUrl,omitempty"`
	// Name - The name of the thing represented by this object.
	Name *string `json:"name,omitempty"`
	// URL - The URL to get more information about the thing represented by this object.
	URL *string `json:"url,omitempty"`
	// Image - An image of the item.
	Image *ImageObject `json:"image,omitempty"`
	// Description - A short description of the item.
	Description *string `json:"description,omitempty"`
	// AlternateName - An alias for the item
	AlternateName *string `json:"alternateName,omitempty"`
	// BingID - An ID that uniquely identifies this item.
	BingID *string `json:"bingId,omitempty"`
	// WebSearchURL - The URL To Bing's search result for this item.
	WebSearchURL *string `json:"webSearchUrl,omitempty"`
	// ID - A String identifier.
	ID *string `json:"id,omitempty"`
	// Type - Possible values include: 'TypeResponseBase', 'TypeNewsArticle', 'TypeNews', 'TypeSearchResultsAnswer', 'TypeImageObject', 'TypeNewsTopic', 'TypeAnswer', 'TypeArticle', 'TypeThing', 'TypeResponse', 'TypeTrendingTopics', 'TypeVideoObject', 'TypeCreativeWork', 'TypeOrganization', 'TypeIdentifiable', 'TypeErrorResponse', 'TypeMediaObject'
	Type Type `json:"_type,omitempty"`
}

NewsTopic ...

func (NewsTopic) AsAnswer

func (nt NewsTopic) AsAnswer() (*Answer, bool)

AsAnswer is the BasicResponseBase implementation for NewsTopic.

func (NewsTopic) AsArticle

func (nt NewsTopic) AsArticle() (*Article, bool)

AsArticle is the BasicResponseBase implementation for NewsTopic.

func (NewsTopic) AsBasicAnswer

func (nt NewsTopic) AsBasicAnswer() (BasicAnswer, bool)

AsBasicAnswer is the BasicResponseBase implementation for NewsTopic.

func (NewsTopic) AsBasicArticle

func (nt NewsTopic) AsBasicArticle() (BasicArticle, bool)

AsBasicArticle is the BasicResponseBase implementation for NewsTopic.

func (NewsTopic) AsBasicCreativeWork

func (nt NewsTopic) AsBasicCreativeWork() (BasicCreativeWork, bool)

AsBasicCreativeWork is the BasicResponseBase implementation for NewsTopic.

func (NewsTopic) AsBasicIdentifiable

func (nt NewsTopic) AsBasicIdentifiable() (BasicIdentifiable, bool)

AsBasicIdentifiable is the BasicResponseBase implementation for NewsTopic.

func (NewsTopic) AsBasicMediaObject

func (nt NewsTopic) AsBasicMediaObject() (BasicMediaObject, bool)

AsBasicMediaObject is the BasicResponseBase implementation for NewsTopic.

func (NewsTopic) AsBasicResponse

func (nt NewsTopic) AsBasicResponse() (BasicResponse, bool)

AsBasicResponse is the BasicResponseBase implementation for NewsTopic.

func (NewsTopic) AsBasicResponseBase

func (nt NewsTopic) AsBasicResponseBase() (BasicResponseBase, bool)

AsBasicResponseBase is the BasicResponseBase implementation for NewsTopic.

func (NewsTopic) AsBasicSearchResultsAnswer

func (nt NewsTopic) AsBasicSearchResultsAnswer() (BasicSearchResultsAnswer, bool)

AsBasicSearchResultsAnswer is the BasicResponseBase implementation for NewsTopic.

func (NewsTopic) AsBasicThing

func (nt NewsTopic) AsBasicThing() (BasicThing, bool)

AsBasicThing is the BasicResponseBase implementation for NewsTopic.

func (NewsTopic) AsCreativeWork

func (nt NewsTopic) AsCreativeWork() (*CreativeWork, bool)

AsCreativeWork is the BasicResponseBase implementation for NewsTopic.

func (NewsTopic) AsErrorResponse

func (nt NewsTopic) AsErrorResponse() (*ErrorResponse, bool)

AsErrorResponse is the BasicResponseBase implementation for NewsTopic.

func (NewsTopic) AsIdentifiable

func (nt NewsTopic) AsIdentifiable() (*Identifiable, bool)

AsIdentifiable is the BasicResponseBase implementation for NewsTopic.

func (NewsTopic) AsImageObject

func (nt NewsTopic) AsImageObject() (*ImageObject, bool)

AsImageObject is the BasicResponseBase implementation for NewsTopic.

func (NewsTopic) AsMediaObject

func (nt NewsTopic) AsMediaObject() (*MediaObject, bool)

AsMediaObject is the BasicResponseBase implementation for NewsTopic.

func (NewsTopic) AsNews

func (nt NewsTopic) AsNews() (*News, bool)

AsNews is the BasicResponseBase implementation for NewsTopic.

func (NewsTopic) AsNewsArticle

func (nt NewsTopic) AsNewsArticle() (*NewsArticle, bool)

AsNewsArticle is the BasicResponseBase implementation for NewsTopic.

func (NewsTopic) AsNewsTopic

func (nt NewsTopic) AsNewsTopic() (*NewsTopic, bool)

AsNewsTopic is the BasicResponseBase implementation for NewsTopic.

func (NewsTopic) AsOrganization

func (nt NewsTopic) AsOrganization() (*Organization, bool)

AsOrganization is the BasicResponseBase implementation for NewsTopic.

func (NewsTopic) AsResponse

func (nt NewsTopic) AsResponse() (*Response, bool)

AsResponse is the BasicResponseBase implementation for NewsTopic.

func (NewsTopic) AsResponseBase

func (nt NewsTopic) AsResponseBase() (*ResponseBase, bool)

AsResponseBase is the BasicResponseBase implementation for NewsTopic.

func (NewsTopic) AsSearchResultsAnswer

func (nt NewsTopic) AsSearchResultsAnswer() (*SearchResultsAnswer, bool)

AsSearchResultsAnswer is the BasicResponseBase implementation for NewsTopic.

func (NewsTopic) AsThing

func (nt NewsTopic) AsThing() (*Thing, bool)

AsThing is the BasicResponseBase implementation for NewsTopic.

func (NewsTopic) AsTrendingTopics

func (nt NewsTopic) AsTrendingTopics() (*TrendingTopics, bool)

AsTrendingTopics is the BasicResponseBase implementation for NewsTopic.

func (NewsTopic) AsVideoObject

func (nt NewsTopic) AsVideoObject() (*VideoObject, bool)

AsVideoObject is the BasicResponseBase implementation for NewsTopic.

func (NewsTopic) MarshalJSON

func (nt NewsTopic) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for NewsTopic.

type Organization

type Organization struct {
	// Name - The name of the thing represented by this object.
	Name *string `json:"name,omitempty"`
	// URL - The URL to get more information about the thing represented by this object.
	URL *string `json:"url,omitempty"`
	// Image - An image of the item.
	Image *ImageObject `json:"image,omitempty"`
	// Description - A short description of the item.
	Description *string `json:"description,omitempty"`
	// AlternateName - An alias for the item
	AlternateName *string `json:"alternateName,omitempty"`
	// BingID - An ID that uniquely identifies this item.
	BingID *string `json:"bingId,omitempty"`
	// WebSearchURL - The URL To Bing's search result for this item.
	WebSearchURL *string `json:"webSearchUrl,omitempty"`
	// ID - A String identifier.
	ID *string `json:"id,omitempty"`
	// Type - Possible values include: 'TypeResponseBase', 'TypeNewsArticle', 'TypeNews', 'TypeSearchResultsAnswer', 'TypeImageObject', 'TypeNewsTopic', 'TypeAnswer', 'TypeArticle', 'TypeThing', 'TypeResponse', 'TypeTrendingTopics', 'TypeVideoObject', 'TypeCreativeWork', 'TypeOrganization', 'TypeIdentifiable', 'TypeErrorResponse', 'TypeMediaObject'
	Type Type `json:"_type,omitempty"`
}

Organization defines an organization.

func (Organization) AsAnswer

func (o Organization) AsAnswer() (*Answer, bool)

AsAnswer is the BasicResponseBase implementation for Organization.

func (Organization) AsArticle

func (o Organization) AsArticle() (*Article, bool)

AsArticle is the BasicResponseBase implementation for Organization.

func (Organization) AsBasicAnswer

func (o Organization) AsBasicAnswer() (BasicAnswer, bool)

AsBasicAnswer is the BasicResponseBase implementation for Organization.

func (Organization) AsBasicArticle

func (o Organization) AsBasicArticle() (BasicArticle, bool)

AsBasicArticle is the BasicResponseBase implementation for Organization.

func (Organization) AsBasicCreativeWork

func (o Organization) AsBasicCreativeWork() (BasicCreativeWork, bool)

AsBasicCreativeWork is the BasicResponseBase implementation for Organization.

func (Organization) AsBasicIdentifiable

func (o Organization) AsBasicIdentifiable() (BasicIdentifiable, bool)

AsBasicIdentifiable is the BasicResponseBase implementation for Organization.

func (Organization) AsBasicMediaObject

func (o Organization) AsBasicMediaObject() (BasicMediaObject, bool)

AsBasicMediaObject is the BasicResponseBase implementation for Organization.

func (Organization) AsBasicResponse

func (o Organization) AsBasicResponse() (BasicResponse, bool)

AsBasicResponse is the BasicResponseBase implementation for Organization.

func (Organization) AsBasicResponseBase

func (o Organization) AsBasicResponseBase() (BasicResponseBase, bool)

AsBasicResponseBase is the BasicResponseBase implementation for Organization.

func (Organization) AsBasicSearchResultsAnswer

func (o Organization) AsBasicSearchResultsAnswer() (BasicSearchResultsAnswer, bool)

AsBasicSearchResultsAnswer is the BasicResponseBase implementation for Organization.

func (Organization) AsBasicThing

func (o Organization) AsBasicThing() (BasicThing, bool)

AsBasicThing is the BasicResponseBase implementation for Organization.

func (Organization) AsCreativeWork

func (o Organization) AsCreativeWork() (*CreativeWork, bool)

AsCreativeWork is the BasicResponseBase implementation for Organization.

func (Organization) AsErrorResponse

func (o Organization) AsErrorResponse() (*ErrorResponse, bool)

AsErrorResponse is the BasicResponseBase implementation for Organization.

func (Organization) AsIdentifiable

func (o Organization) AsIdentifiable() (*Identifiable, bool)

AsIdentifiable is the BasicResponseBase implementation for Organization.

func (Organization) AsImageObject

func (o Organization) AsImageObject() (*ImageObject, bool)

AsImageObject is the BasicResponseBase implementation for Organization.

func (Organization) AsMediaObject

func (o Organization) AsMediaObject() (*MediaObject, bool)

AsMediaObject is the BasicResponseBase implementation for Organization.

func (Organization) AsNews

func (o Organization) AsNews() (*News, bool)

AsNews is the BasicResponseBase implementation for Organization.

func (Organization) AsNewsArticle

func (o Organization) AsNewsArticle() (*NewsArticle, bool)

AsNewsArticle is the BasicResponseBase implementation for Organization.

func (Organization) AsNewsTopic

func (o Organization) AsNewsTopic() (*NewsTopic, bool)

AsNewsTopic is the BasicResponseBase implementation for Organization.

func (Organization) AsOrganization

func (o Organization) AsOrganization() (*Organization, bool)

AsOrganization is the BasicResponseBase implementation for Organization.

func (Organization) AsResponse

func (o Organization) AsResponse() (*Response, bool)

AsResponse is the BasicResponseBase implementation for Organization.

func (Organization) AsResponseBase

func (o Organization) AsResponseBase() (*ResponseBase, bool)

AsResponseBase is the BasicResponseBase implementation for Organization.

func (Organization) AsSearchResultsAnswer

func (o Organization) AsSearchResultsAnswer() (*SearchResultsAnswer, bool)

AsSearchResultsAnswer is the BasicResponseBase implementation for Organization.

func (Organization) AsThing

func (o Organization) AsThing() (*Thing, bool)

AsThing is the BasicResponseBase implementation for Organization.

func (Organization) AsTrendingTopics

func (o Organization) AsTrendingTopics() (*TrendingTopics, bool)

AsTrendingTopics is the BasicResponseBase implementation for Organization.

func (Organization) AsVideoObject

func (o Organization) AsVideoObject() (*VideoObject, bool)

AsVideoObject is the BasicResponseBase implementation for Organization.

func (Organization) MarshalJSON

func (o Organization) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for Organization.

type Query

type Query struct {
	// Text - The query string. Use this string as the query term in a new search request.
	Text *string `json:"text,omitempty"`
	// DisplayText - The display version of the query term. This version of the query term may contain special characters that highlight the search term found in the query string. The string contains the highlighting characters only if the query enabled hit highlighting
	DisplayText *string `json:"displayText,omitempty"`
	// WebSearchURL - The URL that takes the user to the Bing search results page for the query.Only related search results include this field.
	WebSearchURL *string `json:"webSearchUrl,omitempty"`
	// SearchLink - The URL that you use to get the results of the related search. Before using the URL, you must append query parameters as appropriate and include the Ocp-Apim-Subscription-Key header. Use this URL if you're displaying the results in your own user interface. Otherwise, use the webSearchUrl URL.
	SearchLink *string `json:"searchLink,omitempty"`
	// Thumbnail - The URL to a thumbnail of a related image.
	Thumbnail *ImageObject `json:"thumbnail,omitempty"`
}

Query defines a search query.

type Response

type Response struct {
	// WebSearchURL - The URL To Bing's search result for this item.
	WebSearchURL *string `json:"webSearchUrl,omitempty"`
	// ID - A String identifier.
	ID *string `json:"id,omitempty"`
	// Type - Possible values include: 'TypeResponseBase', 'TypeNewsArticle', 'TypeNews', 'TypeSearchResultsAnswer', 'TypeImageObject', 'TypeNewsTopic', 'TypeAnswer', 'TypeArticle', 'TypeThing', 'TypeResponse', 'TypeTrendingTopics', 'TypeVideoObject', 'TypeCreativeWork', 'TypeOrganization', 'TypeIdentifiable', 'TypeErrorResponse', 'TypeMediaObject'
	Type Type `json:"_type,omitempty"`
}

Response defines a response. All schemas that could be returned at the root of a response should inherit from this

func (Response) AsAnswer

func (r Response) AsAnswer() (*Answer, bool)

AsAnswer is the BasicResponseBase implementation for Response.

func (Response) AsArticle

func (r Response) AsArticle() (*Article, bool)

AsArticle is the BasicResponseBase implementation for Response.

func (Response) AsBasicAnswer

func (r Response) AsBasicAnswer() (BasicAnswer, bool)

AsBasicAnswer is the BasicResponseBase implementation for Response.

func (Response) AsBasicArticle

func (r Response) AsBasicArticle() (BasicArticle, bool)

AsBasicArticle is the BasicResponseBase implementation for Response.

func (Response) AsBasicCreativeWork

func (r Response) AsBasicCreativeWork() (BasicCreativeWork, bool)

AsBasicCreativeWork is the BasicResponseBase implementation for Response.

func (Response) AsBasicIdentifiable

func (r Response) AsBasicIdentifiable() (BasicIdentifiable, bool)

AsBasicIdentifiable is the BasicResponseBase implementation for Response.

func (Response) AsBasicMediaObject

func (r Response) AsBasicMediaObject() (BasicMediaObject, bool)

AsBasicMediaObject is the BasicResponseBase implementation for Response.

func (Response) AsBasicResponse

func (r Response) AsBasicResponse() (BasicResponse, bool)

AsBasicResponse is the BasicResponseBase implementation for Response.

func (Response) AsBasicResponseBase

func (r Response) AsBasicResponseBase() (BasicResponseBase, bool)

AsBasicResponseBase is the BasicResponseBase implementation for Response.

func (Response) AsBasicSearchResultsAnswer

func (r Response) AsBasicSearchResultsAnswer() (BasicSearchResultsAnswer, bool)

AsBasicSearchResultsAnswer is the BasicResponseBase implementation for Response.

func (Response) AsBasicThing

func (r Response) AsBasicThing() (BasicThing, bool)

AsBasicThing is the BasicResponseBase implementation for Response.

func (Response) AsCreativeWork

func (r Response) AsCreativeWork() (*CreativeWork, bool)

AsCreativeWork is the BasicResponseBase implementation for Response.

func (Response) AsErrorResponse

func (r Response) AsErrorResponse() (*ErrorResponse, bool)

AsErrorResponse is the BasicResponseBase implementation for Response.

func (Response) AsIdentifiable

func (r Response) AsIdentifiable() (*Identifiable, bool)

AsIdentifiable is the BasicResponseBase implementation for Response.

func (Response) AsImageObject

func (r Response) AsImageObject() (*ImageObject, bool)

AsImageObject is the BasicResponseBase implementation for Response.

func (Response) AsMediaObject

func (r Response) AsMediaObject() (*MediaObject, bool)

AsMediaObject is the BasicResponseBase implementation for Response.

func (Response) AsNews

func (r Response) AsNews() (*News, bool)

AsNews is the BasicResponseBase implementation for Response.

func (Response) AsNewsArticle

func (r Response) AsNewsArticle() (*NewsArticle, bool)

AsNewsArticle is the BasicResponseBase implementation for Response.

func (Response) AsNewsTopic

func (r Response) AsNewsTopic() (*NewsTopic, bool)

AsNewsTopic is the BasicResponseBase implementation for Response.

func (Response) AsOrganization

func (r Response) AsOrganization() (*Organization, bool)

AsOrganization is the BasicResponseBase implementation for Response.

func (Response) AsResponse

func (r Response) AsResponse() (*Response, bool)

AsResponse is the BasicResponseBase implementation for Response.

func (Response) AsResponseBase

func (r Response) AsResponseBase() (*ResponseBase, bool)

AsResponseBase is the BasicResponseBase implementation for Response.

func (Response) AsSearchResultsAnswer

func (r Response) AsSearchResultsAnswer() (*SearchResultsAnswer, bool)

AsSearchResultsAnswer is the BasicResponseBase implementation for Response.

func (Response) AsThing

func (r Response) AsThing() (*Thing, bool)

AsThing is the BasicResponseBase implementation for Response.

func (Response) AsTrendingTopics

func (r Response) AsTrendingTopics() (*TrendingTopics, bool)

AsTrendingTopics is the BasicResponseBase implementation for Response.

func (Response) AsVideoObject

func (r Response) AsVideoObject() (*VideoObject, bool)

AsVideoObject is the BasicResponseBase implementation for Response.

func (Response) MarshalJSON

func (r Response) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for Response.

type ResponseBase

type ResponseBase struct {
	// Type - Possible values include: 'TypeResponseBase', 'TypeNewsArticle', 'TypeNews', 'TypeSearchResultsAnswer', 'TypeImageObject', 'TypeNewsTopic', 'TypeAnswer', 'TypeArticle', 'TypeThing', 'TypeResponse', 'TypeTrendingTopics', 'TypeVideoObject', 'TypeCreativeWork', 'TypeOrganization', 'TypeIdentifiable', 'TypeErrorResponse', 'TypeMediaObject'
	Type Type `json:"_type,omitempty"`
}

ResponseBase response base

func (ResponseBase) AsAnswer

func (rb ResponseBase) AsAnswer() (*Answer, bool)

AsAnswer is the BasicResponseBase implementation for ResponseBase.

func (ResponseBase) AsArticle

func (rb ResponseBase) AsArticle() (*Article, bool)

AsArticle is the BasicResponseBase implementation for ResponseBase.

func (ResponseBase) AsBasicAnswer

func (rb ResponseBase) AsBasicAnswer() (BasicAnswer, bool)

AsBasicAnswer is the BasicResponseBase implementation for ResponseBase.

func (ResponseBase) AsBasicArticle

func (rb ResponseBase) AsBasicArticle() (BasicArticle, bool)

AsBasicArticle is the BasicResponseBase implementation for ResponseBase.

func (ResponseBase) AsBasicCreativeWork

func (rb ResponseBase) AsBasicCreativeWork() (BasicCreativeWork, bool)

AsBasicCreativeWork is the BasicResponseBase implementation for ResponseBase.

func (ResponseBase) AsBasicIdentifiable

func (rb ResponseBase) AsBasicIdentifiable() (BasicIdentifiable, bool)

AsBasicIdentifiable is the BasicResponseBase implementation for ResponseBase.

func (ResponseBase) AsBasicMediaObject

func (rb ResponseBase) AsBasicMediaObject() (BasicMediaObject, bool)

AsBasicMediaObject is the BasicResponseBase implementation for ResponseBase.

func (ResponseBase) AsBasicResponse

func (rb ResponseBase) AsBasicResponse() (BasicResponse, bool)

AsBasicResponse is the BasicResponseBase implementation for ResponseBase.

func (ResponseBase) AsBasicResponseBase

func (rb ResponseBase) AsBasicResponseBase() (BasicResponseBase, bool)

AsBasicResponseBase is the BasicResponseBase implementation for ResponseBase.

func (ResponseBase) AsBasicSearchResultsAnswer

func (rb ResponseBase) AsBasicSearchResultsAnswer() (BasicSearchResultsAnswer, bool)

AsBasicSearchResultsAnswer is the BasicResponseBase implementation for ResponseBase.

func (ResponseBase) AsBasicThing

func (rb ResponseBase) AsBasicThing() (BasicThing, bool)

AsBasicThing is the BasicResponseBase implementation for ResponseBase.

func (ResponseBase) AsCreativeWork

func (rb ResponseBase) AsCreativeWork() (*CreativeWork, bool)

AsCreativeWork is the BasicResponseBase implementation for ResponseBase.

func (ResponseBase) AsErrorResponse

func (rb ResponseBase) AsErrorResponse() (*ErrorResponse, bool)

AsErrorResponse is the BasicResponseBase implementation for ResponseBase.

func (ResponseBase) AsIdentifiable

func (rb ResponseBase) AsIdentifiable() (*Identifiable, bool)

AsIdentifiable is the BasicResponseBase implementation for ResponseBase.

func (ResponseBase) AsImageObject

func (rb ResponseBase) AsImageObject() (*ImageObject, bool)

AsImageObject is the BasicResponseBase implementation for ResponseBase.

func (ResponseBase) AsMediaObject

func (rb ResponseBase) AsMediaObject() (*MediaObject, bool)

AsMediaObject is the BasicResponseBase implementation for ResponseBase.

func (ResponseBase) AsNews

func (rb ResponseBase) AsNews() (*News, bool)

AsNews is the BasicResponseBase implementation for ResponseBase.

func (ResponseBase) AsNewsArticle

func (rb ResponseBase) AsNewsArticle() (*NewsArticle, bool)

AsNewsArticle is the BasicResponseBase implementation for ResponseBase.

func (ResponseBase) AsNewsTopic

func (rb ResponseBase) AsNewsTopic() (*NewsTopic, bool)

AsNewsTopic is the BasicResponseBase implementation for ResponseBase.

func (ResponseBase) AsOrganization

func (rb ResponseBase) AsOrganization() (*Organization, bool)

AsOrganization is the BasicResponseBase implementation for ResponseBase.

func (ResponseBase) AsResponse

func (rb ResponseBase) AsResponse() (*Response, bool)

AsResponse is the BasicResponseBase implementation for ResponseBase.

func (ResponseBase) AsResponseBase

func (rb ResponseBase) AsResponseBase() (*ResponseBase, bool)

AsResponseBase is the BasicResponseBase implementation for ResponseBase.

func (ResponseBase) AsSearchResultsAnswer

func (rb ResponseBase) AsSearchResultsAnswer() (*SearchResultsAnswer, bool)

AsSearchResultsAnswer is the BasicResponseBase implementation for ResponseBase.

func (ResponseBase) AsThing

func (rb ResponseBase) AsThing() (*Thing, bool)

AsThing is the BasicResponseBase implementation for ResponseBase.

func (ResponseBase) AsTrendingTopics

func (rb ResponseBase) AsTrendingTopics() (*TrendingTopics, bool)

AsTrendingTopics is the BasicResponseBase implementation for ResponseBase.

func (ResponseBase) AsVideoObject

func (rb ResponseBase) AsVideoObject() (*VideoObject, bool)

AsVideoObject is the BasicResponseBase implementation for ResponseBase.

func (ResponseBase) MarshalJSON

func (rb ResponseBase) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for ResponseBase.

type SafeSearch

type SafeSearch string

SafeSearch enumerates the values for safe search.

const (
	// Moderate ...
	Moderate SafeSearch = "Moderate"
	// Off ...
	Off SafeSearch = "Off"
	// Strict ...
	Strict SafeSearch = "Strict"
)

func PossibleSafeSearchValues

func PossibleSafeSearchValues() []SafeSearch

PossibleSafeSearchValues returns an array of possible values for the SafeSearch const type.

type SearchResultsAnswer

type SearchResultsAnswer struct {
	// TotalEstimatedMatches - The estimated number of webpages that are relevant to the query. Use this number along with the count and offset query parameters to page the results.
	TotalEstimatedMatches *int64   `json:"totalEstimatedMatches,omitempty"`
	FollowUpQueries       *[]Query `json:"followUpQueries,omitempty"`
	// WebSearchURL - The URL To Bing's search result for this item.
	WebSearchURL *string `json:"webSearchUrl,omitempty"`
	// ID - A String identifier.
	ID *string `json:"id,omitempty"`
	// Type - Possible values include: 'TypeResponseBase', 'TypeNewsArticle', 'TypeNews', 'TypeSearchResultsAnswer', 'TypeImageObject', 'TypeNewsTopic', 'TypeAnswer', 'TypeArticle', 'TypeThing', 'TypeResponse', 'TypeTrendingTopics', 'TypeVideoObject', 'TypeCreativeWork', 'TypeOrganization', 'TypeIdentifiable', 'TypeErrorResponse', 'TypeMediaObject'
	Type Type `json:"_type,omitempty"`
}

SearchResultsAnswer defines a search result answer.

func (SearchResultsAnswer) AsAnswer

func (sra SearchResultsAnswer) AsAnswer() (*Answer, bool)

AsAnswer is the BasicResponseBase implementation for SearchResultsAnswer.

func (SearchResultsAnswer) AsArticle

func (sra SearchResultsAnswer) AsArticle() (*Article, bool)

AsArticle is the BasicResponseBase implementation for SearchResultsAnswer.

func (SearchResultsAnswer) AsBasicAnswer

func (sra SearchResultsAnswer) AsBasicAnswer() (BasicAnswer, bool)

AsBasicAnswer is the BasicResponseBase implementation for SearchResultsAnswer.

func (SearchResultsAnswer) AsBasicArticle

func (sra SearchResultsAnswer) AsBasicArticle() (BasicArticle, bool)

AsBasicArticle is the BasicResponseBase implementation for SearchResultsAnswer.

func (SearchResultsAnswer) AsBasicCreativeWork

func (sra SearchResultsAnswer) AsBasicCreativeWork() (BasicCreativeWork, bool)

AsBasicCreativeWork is the BasicResponseBase implementation for SearchResultsAnswer.

func (SearchResultsAnswer) AsBasicIdentifiable

func (sra SearchResultsAnswer) AsBasicIdentifiable() (BasicIdentifiable, bool)

AsBasicIdentifiable is the BasicResponseBase implementation for SearchResultsAnswer.

func (SearchResultsAnswer) AsBasicMediaObject

func (sra SearchResultsAnswer) AsBasicMediaObject() (BasicMediaObject, bool)

AsBasicMediaObject is the BasicResponseBase implementation for SearchResultsAnswer.

func (SearchResultsAnswer) AsBasicResponse

func (sra SearchResultsAnswer) AsBasicResponse() (BasicResponse, bool)

AsBasicResponse is the BasicResponseBase implementation for SearchResultsAnswer.

func (SearchResultsAnswer) AsBasicResponseBase

func (sra SearchResultsAnswer) AsBasicResponseBase() (BasicResponseBase, bool)

AsBasicResponseBase is the BasicResponseBase implementation for SearchResultsAnswer.

func (SearchResultsAnswer) AsBasicSearchResultsAnswer

func (sra SearchResultsAnswer) AsBasicSearchResultsAnswer() (BasicSearchResultsAnswer, bool)

AsBasicSearchResultsAnswer is the BasicResponseBase implementation for SearchResultsAnswer.

func (SearchResultsAnswer) AsBasicThing

func (sra SearchResultsAnswer) AsBasicThing() (BasicThing, bool)

AsBasicThing is the BasicResponseBase implementation for SearchResultsAnswer.

func (SearchResultsAnswer) AsCreativeWork

func (sra SearchResultsAnswer) AsCreativeWork() (*CreativeWork, bool)

AsCreativeWork is the BasicResponseBase implementation for SearchResultsAnswer.

func (SearchResultsAnswer) AsErrorResponse

func (sra SearchResultsAnswer) AsErrorResponse() (*ErrorResponse, bool)

AsErrorResponse is the BasicResponseBase implementation for SearchResultsAnswer.

func (SearchResultsAnswer) AsIdentifiable

func (sra SearchResultsAnswer) AsIdentifiable() (*Identifiable, bool)

AsIdentifiable is the BasicResponseBase implementation for SearchResultsAnswer.

func (SearchResultsAnswer) AsImageObject

func (sra SearchResultsAnswer) AsImageObject() (*ImageObject, bool)

AsImageObject is the BasicResponseBase implementation for SearchResultsAnswer.

func (SearchResultsAnswer) AsMediaObject

func (sra SearchResultsAnswer) AsMediaObject() (*MediaObject, bool)

AsMediaObject is the BasicResponseBase implementation for SearchResultsAnswer.

func (SearchResultsAnswer) AsNews

func (sra SearchResultsAnswer) AsNews() (*News, bool)

AsNews is the BasicResponseBase implementation for SearchResultsAnswer.

func (SearchResultsAnswer) AsNewsArticle

func (sra SearchResultsAnswer) AsNewsArticle() (*NewsArticle, bool)

AsNewsArticle is the BasicResponseBase implementation for SearchResultsAnswer.

func (SearchResultsAnswer) AsNewsTopic

func (sra SearchResultsAnswer) AsNewsTopic() (*NewsTopic, bool)

AsNewsTopic is the BasicResponseBase implementation for SearchResultsAnswer.

func (SearchResultsAnswer) AsOrganization

func (sra SearchResultsAnswer) AsOrganization() (*Organization, bool)

AsOrganization is the BasicResponseBase implementation for SearchResultsAnswer.

func (SearchResultsAnswer) AsResponse

func (sra SearchResultsAnswer) AsResponse() (*Response, bool)

AsResponse is the BasicResponseBase implementation for SearchResultsAnswer.

func (SearchResultsAnswer) AsResponseBase

func (sra SearchResultsAnswer) AsResponseBase() (*ResponseBase, bool)

AsResponseBase is the BasicResponseBase implementation for SearchResultsAnswer.

func (SearchResultsAnswer) AsSearchResultsAnswer

func (sra SearchResultsAnswer) AsSearchResultsAnswer() (*SearchResultsAnswer, bool)

AsSearchResultsAnswer is the BasicResponseBase implementation for SearchResultsAnswer.

func (SearchResultsAnswer) AsThing

func (sra SearchResultsAnswer) AsThing() (*Thing, bool)

AsThing is the BasicResponseBase implementation for SearchResultsAnswer.

func (SearchResultsAnswer) AsTrendingTopics

func (sra SearchResultsAnswer) AsTrendingTopics() (*TrendingTopics, bool)

AsTrendingTopics is the BasicResponseBase implementation for SearchResultsAnswer.

func (SearchResultsAnswer) AsVideoObject

func (sra SearchResultsAnswer) AsVideoObject() (*VideoObject, bool)

AsVideoObject is the BasicResponseBase implementation for SearchResultsAnswer.

func (SearchResultsAnswer) MarshalJSON

func (sra SearchResultsAnswer) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for SearchResultsAnswer.

type TextFormat

type TextFormat string

TextFormat enumerates the values for text format.

const (
	// HTML ...
	HTML TextFormat = "Html"
	// Raw ...
	Raw TextFormat = "Raw"
)

func PossibleTextFormatValues

func PossibleTextFormatValues() []TextFormat

PossibleTextFormatValues returns an array of possible values for the TextFormat const type.

type Thing

type Thing struct {
	// Name - The name of the thing represented by this object.
	Name *string `json:"name,omitempty"`
	// URL - The URL to get more information about the thing represented by this object.
	URL *string `json:"url,omitempty"`
	// Image - An image of the item.
	Image *ImageObject `json:"image,omitempty"`
	// Description - A short description of the item.
	Description *string `json:"description,omitempty"`
	// AlternateName - An alias for the item
	AlternateName *string `json:"alternateName,omitempty"`
	// BingID - An ID that uniquely identifies this item.
	BingID *string `json:"bingId,omitempty"`
	// WebSearchURL - The URL To Bing's search result for this item.
	WebSearchURL *string `json:"webSearchUrl,omitempty"`
	// ID - A String identifier.
	ID *string `json:"id,omitempty"`
	// Type - Possible values include: 'TypeResponseBase', 'TypeNewsArticle', 'TypeNews', 'TypeSearchResultsAnswer', 'TypeImageObject', 'TypeNewsTopic', 'TypeAnswer', 'TypeArticle', 'TypeThing', 'TypeResponse', 'TypeTrendingTopics', 'TypeVideoObject', 'TypeCreativeWork', 'TypeOrganization', 'TypeIdentifiable', 'TypeErrorResponse', 'TypeMediaObject'
	Type Type `json:"_type,omitempty"`
}

Thing defines a thing.

func (Thing) AsAnswer

func (t Thing) AsAnswer() (*Answer, bool)

AsAnswer is the BasicResponseBase implementation for Thing.

func (Thing) AsArticle

func (t Thing) AsArticle() (*Article, bool)

AsArticle is the BasicResponseBase implementation for Thing.

func (Thing) AsBasicAnswer

func (t Thing) AsBasicAnswer() (BasicAnswer, bool)

AsBasicAnswer is the BasicResponseBase implementation for Thing.

func (Thing) AsBasicArticle

func (t Thing) AsBasicArticle() (BasicArticle, bool)

AsBasicArticle is the BasicResponseBase implementation for Thing.

func (Thing) AsBasicCreativeWork

func (t Thing) AsBasicCreativeWork() (BasicCreativeWork, bool)

AsBasicCreativeWork is the BasicResponseBase implementation for Thing.

func (Thing) AsBasicIdentifiable

func (t Thing) AsBasicIdentifiable() (BasicIdentifiable, bool)

AsBasicIdentifiable is the BasicResponseBase implementation for Thing.

func (Thing) AsBasicMediaObject

func (t Thing) AsBasicMediaObject() (BasicMediaObject, bool)

AsBasicMediaObject is the BasicResponseBase implementation for Thing.

func (Thing) AsBasicResponse

func (t Thing) AsBasicResponse() (BasicResponse, bool)

AsBasicResponse is the BasicResponseBase implementation for Thing.

func (Thing) AsBasicResponseBase

func (t Thing) AsBasicResponseBase() (BasicResponseBase, bool)

AsBasicResponseBase is the BasicResponseBase implementation for Thing.

func (Thing) AsBasicSearchResultsAnswer

func (t Thing) AsBasicSearchResultsAnswer() (BasicSearchResultsAnswer, bool)

AsBasicSearchResultsAnswer is the BasicResponseBase implementation for Thing.

func (Thing) AsBasicThing

func (t Thing) AsBasicThing() (BasicThing, bool)

AsBasicThing is the BasicResponseBase implementation for Thing.

func (Thing) AsCreativeWork

func (t Thing) AsCreativeWork() (*CreativeWork, bool)

AsCreativeWork is the BasicResponseBase implementation for Thing.

func (Thing) AsErrorResponse

func (t Thing) AsErrorResponse() (*ErrorResponse, bool)

AsErrorResponse is the BasicResponseBase implementation for Thing.

func (Thing) AsIdentifiable

func (t Thing) AsIdentifiable() (*Identifiable, bool)

AsIdentifiable is the BasicResponseBase implementation for Thing.

func (Thing) AsImageObject

func (t Thing) AsImageObject() (*ImageObject, bool)

AsImageObject is the BasicResponseBase implementation for Thing.

func (Thing) AsMediaObject

func (t Thing) AsMediaObject() (*MediaObject, bool)

AsMediaObject is the BasicResponseBase implementation for Thing.

func (Thing) AsNews

func (t Thing) AsNews() (*News, bool)

AsNews is the BasicResponseBase implementation for Thing.

func (Thing) AsNewsArticle

func (t Thing) AsNewsArticle() (*NewsArticle, bool)

AsNewsArticle is the BasicResponseBase implementation for Thing.

func (Thing) AsNewsTopic

func (t Thing) AsNewsTopic() (*NewsTopic, bool)

AsNewsTopic is the BasicResponseBase implementation for Thing.

func (Thing) AsOrganization

func (t Thing) AsOrganization() (*Organization, bool)

AsOrganization is the BasicResponseBase implementation for Thing.

func (Thing) AsResponse

func (t Thing) AsResponse() (*Response, bool)

AsResponse is the BasicResponseBase implementation for Thing.

func (Thing) AsResponseBase

func (t Thing) AsResponseBase() (*ResponseBase, bool)

AsResponseBase is the BasicResponseBase implementation for Thing.

func (Thing) AsSearchResultsAnswer

func (t Thing) AsSearchResultsAnswer() (*SearchResultsAnswer, bool)

AsSearchResultsAnswer is the BasicResponseBase implementation for Thing.

func (Thing) AsThing

func (t Thing) AsThing() (*Thing, bool)

AsThing is the BasicResponseBase implementation for Thing.

func (Thing) AsTrendingTopics

func (t Thing) AsTrendingTopics() (*TrendingTopics, bool)

AsTrendingTopics is the BasicResponseBase implementation for Thing.

func (Thing) AsVideoObject

func (t Thing) AsVideoObject() (*VideoObject, bool)

AsVideoObject is the BasicResponseBase implementation for Thing.

func (Thing) MarshalJSON

func (t Thing) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for Thing.

type TrendingTopics

type TrendingTopics struct {
	autorest.Response `json:"-"`
	// Value - A list of trending news topics on Bing
	Value           *[]NewsTopic `json:"value,omitempty"`
	FollowUpQueries *[]Query     `json:"followUpQueries,omitempty"`
	// WebSearchURL - The URL To Bing's search result for this item.
	WebSearchURL *string `json:"webSearchUrl,omitempty"`
	// ID - A String identifier.
	ID *string `json:"id,omitempty"`
	// Type - Possible values include: 'TypeResponseBase', 'TypeNewsArticle', 'TypeNews', 'TypeSearchResultsAnswer', 'TypeImageObject', 'TypeNewsTopic', 'TypeAnswer', 'TypeArticle', 'TypeThing', 'TypeResponse', 'TypeTrendingTopics', 'TypeVideoObject', 'TypeCreativeWork', 'TypeOrganization', 'TypeIdentifiable', 'TypeErrorResponse', 'TypeMediaObject'
	Type Type `json:"_type,omitempty"`
}

TrendingTopics ...

func (TrendingTopics) AsAnswer

func (tt TrendingTopics) AsAnswer() (*Answer, bool)

AsAnswer is the BasicResponseBase implementation for TrendingTopics.

func (TrendingTopics) AsArticle

func (tt TrendingTopics) AsArticle() (*Article, bool)

AsArticle is the BasicResponseBase implementation for TrendingTopics.

func (TrendingTopics) AsBasicAnswer

func (tt TrendingTopics) AsBasicAnswer() (BasicAnswer, bool)

AsBasicAnswer is the BasicResponseBase implementation for TrendingTopics.

func (TrendingTopics) AsBasicArticle

func (tt TrendingTopics) AsBasicArticle() (BasicArticle, bool)

AsBasicArticle is the BasicResponseBase implementation for TrendingTopics.

func (TrendingTopics) AsBasicCreativeWork

func (tt TrendingTopics) AsBasicCreativeWork() (BasicCreativeWork, bool)

AsBasicCreativeWork is the BasicResponseBase implementation for TrendingTopics.

func (TrendingTopics) AsBasicIdentifiable

func (tt TrendingTopics) AsBasicIdentifiable() (BasicIdentifiable, bool)

AsBasicIdentifiable is the BasicResponseBase implementation for TrendingTopics.

func (TrendingTopics) AsBasicMediaObject

func (tt TrendingTopics) AsBasicMediaObject() (BasicMediaObject, bool)

AsBasicMediaObject is the BasicResponseBase implementation for TrendingTopics.

func (TrendingTopics) AsBasicResponse

func (tt TrendingTopics) AsBasicResponse() (BasicResponse, bool)

AsBasicResponse is the BasicResponseBase implementation for TrendingTopics.

func (TrendingTopics) AsBasicResponseBase

func (tt TrendingTopics) AsBasicResponseBase() (BasicResponseBase, bool)

AsBasicResponseBase is the BasicResponseBase implementation for TrendingTopics.

func (TrendingTopics) AsBasicSearchResultsAnswer

func (tt TrendingTopics) AsBasicSearchResultsAnswer() (BasicSearchResultsAnswer, bool)

AsBasicSearchResultsAnswer is the BasicResponseBase implementation for TrendingTopics.

func (TrendingTopics) AsBasicThing

func (tt TrendingTopics) AsBasicThing() (BasicThing, bool)

AsBasicThing is the BasicResponseBase implementation for TrendingTopics.

func (TrendingTopics) AsCreativeWork

func (tt TrendingTopics) AsCreativeWork() (*CreativeWork, bool)

AsCreativeWork is the BasicResponseBase implementation for TrendingTopics.

func (TrendingTopics) AsErrorResponse

func (tt TrendingTopics) AsErrorResponse() (*ErrorResponse, bool)

AsErrorResponse is the BasicResponseBase implementation for TrendingTopics.

func (TrendingTopics) AsIdentifiable

func (tt TrendingTopics) AsIdentifiable() (*Identifiable, bool)

AsIdentifiable is the BasicResponseBase implementation for TrendingTopics.

func (TrendingTopics) AsImageObject

func (tt TrendingTopics) AsImageObject() (*ImageObject, bool)

AsImageObject is the BasicResponseBase implementation for TrendingTopics.

func (TrendingTopics) AsMediaObject

func (tt TrendingTopics) AsMediaObject() (*MediaObject, bool)

AsMediaObject is the BasicResponseBase implementation for TrendingTopics.

func (TrendingTopics) AsNews

func (tt TrendingTopics) AsNews() (*News, bool)

AsNews is the BasicResponseBase implementation for TrendingTopics.

func (TrendingTopics) AsNewsArticle

func (tt TrendingTopics) AsNewsArticle() (*NewsArticle, bool)

AsNewsArticle is the BasicResponseBase implementation for TrendingTopics.

func (TrendingTopics) AsNewsTopic

func (tt TrendingTopics) AsNewsTopic() (*NewsTopic, bool)

AsNewsTopic is the BasicResponseBase implementation for TrendingTopics.

func (TrendingTopics) AsOrganization

func (tt TrendingTopics) AsOrganization() (*Organization, bool)

AsOrganization is the BasicResponseBase implementation for TrendingTopics.

func (TrendingTopics) AsResponse

func (tt TrendingTopics) AsResponse() (*Response, bool)

AsResponse is the BasicResponseBase implementation for TrendingTopics.

func (TrendingTopics) AsResponseBase

func (tt TrendingTopics) AsResponseBase() (*ResponseBase, bool)

AsResponseBase is the BasicResponseBase implementation for TrendingTopics.

func (TrendingTopics) AsSearchResultsAnswer

func (tt TrendingTopics) AsSearchResultsAnswer() (*SearchResultsAnswer, bool)

AsSearchResultsAnswer is the BasicResponseBase implementation for TrendingTopics.

func (TrendingTopics) AsThing

func (tt TrendingTopics) AsThing() (*Thing, bool)

AsThing is the BasicResponseBase implementation for TrendingTopics.

func (TrendingTopics) AsTrendingTopics

func (tt TrendingTopics) AsTrendingTopics() (*TrendingTopics, bool)

AsTrendingTopics is the BasicResponseBase implementation for TrendingTopics.

func (TrendingTopics) AsVideoObject

func (tt TrendingTopics) AsVideoObject() (*VideoObject, bool)

AsVideoObject is the BasicResponseBase implementation for TrendingTopics.

func (TrendingTopics) MarshalJSON

func (tt TrendingTopics) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for TrendingTopics.

type Type

type Type string

Type enumerates the values for type.

const (
	// TypeAnswer ...
	TypeAnswer Type = "Answer"
	// TypeArticle ...
	TypeArticle Type = "Article"
	// TypeCreativeWork ...
	TypeCreativeWork Type = "CreativeWork"
	// TypeErrorResponse ...
	TypeErrorResponse Type = "ErrorResponse"
	// TypeIdentifiable ...
	TypeIdentifiable Type = "Identifiable"
	// TypeImageObject ...
	TypeImageObject Type = "ImageObject"
	// TypeMediaObject ...
	TypeMediaObject Type = "MediaObject"
	// TypeNews ...
	TypeNews Type = "News"
	// TypeNewsArticle ...
	TypeNewsArticle Type = "NewsArticle"
	// TypeNewsTopic ...
	TypeNewsTopic Type = "News/Topic"
	// TypeOrganization ...
	TypeOrganization Type = "Organization"
	// TypeResponse ...
	TypeResponse Type = "Response"
	// TypeResponseBase ...
	TypeResponseBase Type = "ResponseBase"
	// TypeSearchResultsAnswer ...
	TypeSearchResultsAnswer Type = "SearchResultsAnswer"
	// TypeThing ...
	TypeThing Type = "Thing"
	// TypeTrendingTopics ...
	TypeTrendingTopics Type = "TrendingTopics"
	// TypeVideoObject ...
	TypeVideoObject Type = "VideoObject"
)

func PossibleTypeValues

func PossibleTypeValues() []Type

PossibleTypeValues returns an array of possible values for the Type const type.

type VideoObject

type VideoObject struct {
	MotionThumbnailURL *string      `json:"motionThumbnailUrl,omitempty"`
	MotionThumbnailID  *string      `json:"motionThumbnailId,omitempty"`
	EmbedHTML          *string      `json:"embedHtml,omitempty"`
	AllowHTTPSEmbed    *bool        `json:"allowHttpsEmbed,omitempty"`
	ViewCount          *int32       `json:"viewCount,omitempty"`
	Thumbnail          *ImageObject `json:"thumbnail,omitempty"`
	VideoID            *string      `json:"videoId,omitempty"`
	AllowMobileEmbed   *bool        `json:"allowMobileEmbed,omitempty"`
	IsSuperfresh       *bool        `json:"isSuperfresh,omitempty"`
	// ContentURL - Original URL to retrieve the source (file) for the media object (e.g the source URL for the image).
	ContentURL *string `json:"contentUrl,omitempty"`
	// Width - The width of the source media object, in pixels.
	Width *int32 `json:"width,omitempty"`
	// Height - The height of the source media object, in pixels.
	Height *int32 `json:"height,omitempty"`
	// ThumbnailURL - The URL to a thumbnail of the item.
	ThumbnailURL *string `json:"thumbnailUrl,omitempty"`
	// Provider - The source of the creative work.
	Provider *[]BasicThing `json:"provider,omitempty"`
	// DatePublished - The date on which the CreativeWork was published.
	DatePublished *string `json:"datePublished,omitempty"`
	// Video - A video of the item.
	Video *VideoObject `json:"video,omitempty"`
	// Name - The name of the thing represented by this object.
	Name *string `json:"name,omitempty"`
	// URL - The URL to get more information about the thing represented by this object.
	URL *string `json:"url,omitempty"`
	// Image - An image of the item.
	Image *ImageObject `json:"image,omitempty"`
	// Description - A short description of the item.
	Description *string `json:"description,omitempty"`
	// AlternateName - An alias for the item
	AlternateName *string `json:"alternateName,omitempty"`
	// BingID - An ID that uniquely identifies this item.
	BingID *string `json:"bingId,omitempty"`
	// WebSearchURL - The URL To Bing's search result for this item.
	WebSearchURL *string `json:"webSearchUrl,omitempty"`
	// ID - A String identifier.
	ID *string `json:"id,omitempty"`
	// Type - Possible values include: 'TypeResponseBase', 'TypeNewsArticle', 'TypeNews', 'TypeSearchResultsAnswer', 'TypeImageObject', 'TypeNewsTopic', 'TypeAnswer', 'TypeArticle', 'TypeThing', 'TypeResponse', 'TypeTrendingTopics', 'TypeVideoObject', 'TypeCreativeWork', 'TypeOrganization', 'TypeIdentifiable', 'TypeErrorResponse', 'TypeMediaObject'
	Type Type `json:"_type,omitempty"`
}

VideoObject defines a video object that is relevant to the query.

func (VideoObject) AsAnswer

func (vo VideoObject) AsAnswer() (*Answer, bool)

AsAnswer is the BasicResponseBase implementation for VideoObject.

func (VideoObject) AsArticle

func (vo VideoObject) AsArticle() (*Article, bool)

AsArticle is the BasicResponseBase implementation for VideoObject.

func (VideoObject) AsBasicAnswer

func (vo VideoObject) AsBasicAnswer() (BasicAnswer, bool)

AsBasicAnswer is the BasicResponseBase implementation for VideoObject.

func (VideoObject) AsBasicArticle

func (vo VideoObject) AsBasicArticle() (BasicArticle, bool)

AsBasicArticle is the BasicResponseBase implementation for VideoObject.

func (VideoObject) AsBasicCreativeWork

func (vo VideoObject) AsBasicCreativeWork() (BasicCreativeWork, bool)

AsBasicCreativeWork is the BasicResponseBase implementation for VideoObject.

func (VideoObject) AsBasicIdentifiable

func (vo VideoObject) AsBasicIdentifiable() (BasicIdentifiable, bool)

AsBasicIdentifiable is the BasicResponseBase implementation for VideoObject.

func (VideoObject) AsBasicMediaObject

func (vo VideoObject) AsBasicMediaObject() (BasicMediaObject, bool)

AsBasicMediaObject is the BasicResponseBase implementation for VideoObject.

func (VideoObject) AsBasicResponse

func (vo VideoObject) AsBasicResponse() (BasicResponse, bool)

AsBasicResponse is the BasicResponseBase implementation for VideoObject.

func (VideoObject) AsBasicResponseBase

func (vo VideoObject) AsBasicResponseBase() (BasicResponseBase, bool)

AsBasicResponseBase is the BasicResponseBase implementation for VideoObject.

func (VideoObject) AsBasicSearchResultsAnswer

func (vo VideoObject) AsBasicSearchResultsAnswer() (BasicSearchResultsAnswer, bool)

AsBasicSearchResultsAnswer is the BasicResponseBase implementation for VideoObject.

func (VideoObject) AsBasicThing

func (vo VideoObject) AsBasicThing() (BasicThing, bool)

AsBasicThing is the BasicResponseBase implementation for VideoObject.

func (VideoObject) AsCreativeWork

func (vo VideoObject) AsCreativeWork() (*CreativeWork, bool)

AsCreativeWork is the BasicResponseBase implementation for VideoObject.

func (VideoObject) AsErrorResponse

func (vo VideoObject) AsErrorResponse() (*ErrorResponse, bool)

AsErrorResponse is the BasicResponseBase implementation for VideoObject.

func (VideoObject) AsIdentifiable

func (vo VideoObject) AsIdentifiable() (*Identifiable, bool)

AsIdentifiable is the BasicResponseBase implementation for VideoObject.

func (VideoObject) AsImageObject

func (vo VideoObject) AsImageObject() (*ImageObject, bool)

AsImageObject is the BasicResponseBase implementation for VideoObject.

func (VideoObject) AsMediaObject

func (vo VideoObject) AsMediaObject() (*MediaObject, bool)

AsMediaObject is the BasicResponseBase implementation for VideoObject.

func (VideoObject) AsNews

func (vo VideoObject) AsNews() (*News, bool)

AsNews is the BasicResponseBase implementation for VideoObject.

func (VideoObject) AsNewsArticle

func (vo VideoObject) AsNewsArticle() (*NewsArticle, bool)

AsNewsArticle is the BasicResponseBase implementation for VideoObject.

func (VideoObject) AsNewsTopic

func (vo VideoObject) AsNewsTopic() (*NewsTopic, bool)

AsNewsTopic is the BasicResponseBase implementation for VideoObject.

func (VideoObject) AsOrganization

func (vo VideoObject) AsOrganization() (*Organization, bool)

AsOrganization is the BasicResponseBase implementation for VideoObject.

func (VideoObject) AsResponse

func (vo VideoObject) AsResponse() (*Response, bool)

AsResponse is the BasicResponseBase implementation for VideoObject.

func (VideoObject) AsResponseBase

func (vo VideoObject) AsResponseBase() (*ResponseBase, bool)

AsResponseBase is the BasicResponseBase implementation for VideoObject.

func (VideoObject) AsSearchResultsAnswer

func (vo VideoObject) AsSearchResultsAnswer() (*SearchResultsAnswer, bool)

AsSearchResultsAnswer is the BasicResponseBase implementation for VideoObject.

func (VideoObject) AsThing

func (vo VideoObject) AsThing() (*Thing, bool)

AsThing is the BasicResponseBase implementation for VideoObject.

func (VideoObject) AsTrendingTopics

func (vo VideoObject) AsTrendingTopics() (*TrendingTopics, bool)

AsTrendingTopics is the BasicResponseBase implementation for VideoObject.

func (VideoObject) AsVideoObject

func (vo VideoObject) AsVideoObject() (*VideoObject, bool)

AsVideoObject is the BasicResponseBase implementation for VideoObject.

func (VideoObject) MarshalJSON

func (vo VideoObject) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for VideoObject.

func (*VideoObject) UnmarshalJSON

func (vo *VideoObject) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for VideoObject struct.

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL