videosearch

package
v27.0.0 Latest Latest
Warning

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

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

Documentation

Overview

Package videosearch implements the Azure ARM Videosearch service API version 1.0.

The Video Search API lets you search on Bing for video that are relevant to the user's search query, for insights about a video or for videos that are trending based on search requests made by others. This section provides technical details about the query parameters and headers that you use to request videos and the JSON response objects that contain them. For examples that show how to make requests, see [Searching the Web for Videos](https://docs.microsoft.com/azure/cognitive-services/bing-video-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', 'TypeImageObject', 'TypeVideoObject', 'TypeVideos', 'TypeSearchResultsAnswer', 'TypeAnswer', 'TypeMediaObject', 'TypeResponse', 'TypeThing', 'TypeCreativeWork', 'TypeIdentifiable', 'TypeErrorResponse', 'TypeTrendingVideos', 'TypeVideoDetails'
	Type Type `json:"_type,omitempty"`
}

Answer ...

func (Answer) AsAnswer 

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

AsAnswer is the BasicResponseBase implementation for Answer.

func (Answer) AsBasicAnswer 

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

AsBasicAnswer 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) 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) AsTrendingVideos 

func (a Answer) AsTrendingVideos() (*TrendingVideos, bool)

AsTrendingVideos is the BasicResponseBase implementation for Answer.

func (Answer) AsVideoDetails 

func (a Answer) AsVideoDetails() (*VideoDetails, bool)

AsVideoDetails is the BasicResponseBase implementation for Answer.

func (Answer) AsVideoObject 

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

AsVideoObject is the BasicResponseBase implementation for Answer.

func (Answer) AsVideos 

func (a Answer) AsVideos() (*Videos, bool)

AsVideos is the BasicResponseBase implementation for Answer.

func (Answer) MarshalJSON 

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

MarshalJSON is the custom marshaler for Answer.

type BaseClient 

type BaseClient struct {
	autorest.Client
	Endpoint string
}

BaseClient is the base client for Videosearch.

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 {
	AsVideos() (*Videos, bool)
	AsSearchResultsAnswer() (*SearchResultsAnswer, bool)
	AsBasicSearchResultsAnswer() (BasicSearchResultsAnswer, bool)
	AsAnswer() (*Answer, bool)
}

BasicAnswer ...

type BasicCreativeWork 

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

BasicCreativeWork ...

type BasicIdentifiable 

type BasicIdentifiable interface {
	AsImageObject() (*ImageObject, bool)
	AsVideoObject() (*VideoObject, bool)
	AsVideos() (*Videos, bool)
	AsSearchResultsAnswer() (*SearchResultsAnswer, bool)
	AsBasicSearchResultsAnswer() (BasicSearchResultsAnswer, bool)
	AsAnswer() (*Answer, bool)
	AsBasicAnswer() (BasicAnswer, bool)
	AsMediaObject() (*MediaObject, bool)
	AsBasicMediaObject() (BasicMediaObject, bool)
	AsResponse() (*Response, bool)
	AsBasicResponse() (BasicResponse, bool)
	AsThing() (*Thing, bool)
	AsBasicThing() (BasicThing, bool)
	AsCreativeWork() (*CreativeWork, bool)
	AsBasicCreativeWork() (BasicCreativeWork, bool)
	AsErrorResponse() (*ErrorResponse, bool)
	AsTrendingVideos() (*TrendingVideos, bool)
	AsVideoDetails() (*VideoDetails, 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 ...

type BasicResponse 

type BasicResponse interface {
	AsImageObject() (*ImageObject, bool)
	AsVideoObject() (*VideoObject, bool)
	AsVideos() (*Videos, bool)
	AsSearchResultsAnswer() (*SearchResultsAnswer, bool)
	AsBasicSearchResultsAnswer() (BasicSearchResultsAnswer, bool)
	AsAnswer() (*Answer, bool)
	AsBasicAnswer() (BasicAnswer, bool)
	AsMediaObject() (*MediaObject, bool)
	AsBasicMediaObject() (BasicMediaObject, bool)
	AsThing() (*Thing, bool)
	AsBasicThing() (BasicThing, bool)
	AsCreativeWork() (*CreativeWork, bool)
	AsBasicCreativeWork() (BasicCreativeWork, bool)
	AsErrorResponse() (*ErrorResponse, bool)
	AsTrendingVideos() (*TrendingVideos, bool)
	AsVideoDetails() (*VideoDetails, 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 {
	AsImageObject() (*ImageObject, bool)
	AsVideoObject() (*VideoObject, bool)
	AsVideos() (*Videos, bool)
	AsSearchResultsAnswer() (*SearchResultsAnswer, bool)
	AsBasicSearchResultsAnswer() (BasicSearchResultsAnswer, bool)
	AsAnswer() (*Answer, bool)
	AsBasicAnswer() (BasicAnswer, bool)
	AsMediaObject() (*MediaObject, bool)
	AsBasicMediaObject() (BasicMediaObject, bool)
	AsResponse() (*Response, bool)
	AsBasicResponse() (BasicResponse, bool)
	AsThing() (*Thing, bool)
	AsBasicThing() (BasicThing, bool)
	AsCreativeWork() (*CreativeWork, bool)
	AsBasicCreativeWork() (BasicCreativeWork, bool)
	AsIdentifiable() (*Identifiable, bool)
	AsBasicIdentifiable() (BasicIdentifiable, bool)
	AsErrorResponse() (*ErrorResponse, bool)
	AsTrendingVideos() (*TrendingVideos, bool)
	AsVideoDetails() (*VideoDetails, bool)
	AsResponseBase() (*ResponseBase, bool)
}

BasicResponseBase ...

type BasicSearchResultsAnswer 

type BasicSearchResultsAnswer interface {
	AsVideos() (*Videos, bool)
	AsSearchResultsAnswer() (*SearchResultsAnswer, bool)
}

BasicSearchResultsAnswer ...

type BasicThing 

type BasicThing interface {
	AsImageObject() (*ImageObject, bool)
	AsVideoObject() (*VideoObject, bool)
	AsMediaObject() (*MediaObject, bool)
	AsBasicMediaObject() (BasicMediaObject, bool)
	AsCreativeWork() (*CreativeWork, bool)
	AsBasicCreativeWork() (BasicCreativeWork, bool)
	AsThing() (*Thing, bool)
}

BasicThing ...

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"`
	Text     *string       `json:"text,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 *ImageObject `json:"image,omitempty"`
	// Description - A short description of the item.
	Description   *string `json:"description,omitempty"`
	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', 'TypeImageObject', 'TypeVideoObject', 'TypeVideos', 'TypeSearchResultsAnswer', 'TypeAnswer', 'TypeMediaObject', 'TypeResponse', 'TypeThing', 'TypeCreativeWork', 'TypeIdentifiable', 'TypeErrorResponse', 'TypeTrendingVideos', 'TypeVideoDetails'
	Type Type `json:"_type,omitempty"`
}

CreativeWork ...

func (CreativeWork) AsAnswer 

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

AsAnswer is the BasicResponseBase implementation for CreativeWork.

func (CreativeWork) AsBasicAnswer 

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

AsBasicAnswer 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) 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) AsTrendingVideos 

func (cw CreativeWork) AsTrendingVideos() (*TrendingVideos, bool)

AsTrendingVideos is the BasicResponseBase implementation for CreativeWork.

func (CreativeWork) AsVideoDetails 

func (cw CreativeWork) AsVideoDetails() (*VideoDetails, bool)

AsVideoDetails is the BasicResponseBase implementation for CreativeWork.

func (CreativeWork) AsVideoObject 

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

AsVideoObject is the BasicResponseBase implementation for CreativeWork.

func (CreativeWork) AsVideos 

func (cw CreativeWork) AsVideos() (*Videos, bool)

AsVideos 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', 'TypeImageObject', 'TypeVideoObject', 'TypeVideos', 'TypeSearchResultsAnswer', 'TypeAnswer', 'TypeMediaObject', 'TypeResponse', 'TypeThing', 'TypeCreativeWork', 'TypeIdentifiable', 'TypeErrorResponse', 'TypeTrendingVideos', 'TypeVideoDetails'
	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) AsBasicAnswer 

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

AsBasicAnswer 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) 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) AsTrendingVideos 

func (er ErrorResponse) AsTrendingVideos() (*TrendingVideos, bool)

AsTrendingVideos is the BasicResponseBase implementation for ErrorResponse.

func (ErrorResponse) AsVideoDetails 

func (er ErrorResponse) AsVideoDetails() (*VideoDetails, bool)

AsVideoDetails is the BasicResponseBase implementation for ErrorResponse.

func (ErrorResponse) AsVideoObject 

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

AsVideoObject is the BasicResponseBase implementation for ErrorResponse.

func (ErrorResponse) AsVideos 

func (er ErrorResponse) AsVideos() (*Videos, bool)

AsVideos 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', 'TypeImageObject', 'TypeVideoObject', 'TypeVideos', 'TypeSearchResultsAnswer', 'TypeAnswer', 'TypeMediaObject', 'TypeResponse', 'TypeThing', 'TypeCreativeWork', 'TypeIdentifiable', 'TypeErrorResponse', 'TypeTrendingVideos', 'TypeVideoDetails'
	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) AsBasicAnswer 

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

AsBasicAnswer 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) 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) AsTrendingVideos 

func (i Identifiable) AsTrendingVideos() (*TrendingVideos, bool)

AsTrendingVideos is the BasicResponseBase implementation for Identifiable.

func (Identifiable) AsVideoDetails 

func (i Identifiable) AsVideoDetails() (*VideoDetails, bool)

AsVideoDetails is the BasicResponseBase implementation for Identifiable.

func (Identifiable) AsVideoObject 

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

AsVideoObject is the BasicResponseBase implementation for Identifiable.

func (Identifiable) AsVideos 

func (i Identifiable) AsVideos() (*Videos, bool)

AsVideos 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"`
	// HostPageURL - URL of the page that hosts the media object.
	HostPageURL *string `json:"hostPageUrl,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"`
	Text     *string       `json:"text,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 *ImageObject `json:"image,omitempty"`
	// Description - A short description of the item.
	Description   *string `json:"description,omitempty"`
	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', 'TypeImageObject', 'TypeVideoObject', 'TypeVideos', 'TypeSearchResultsAnswer', 'TypeAnswer', 'TypeMediaObject', 'TypeResponse', 'TypeThing', 'TypeCreativeWork', 'TypeIdentifiable', 'TypeErrorResponse', 'TypeTrendingVideos', 'TypeVideoDetails'
	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) AsBasicAnswer 

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

AsBasicAnswer 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) 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) AsTrendingVideos 

func (ioVar ImageObject) AsTrendingVideos() (*TrendingVideos, bool)

AsTrendingVideos is the BasicResponseBase implementation for ImageObject.

func (ImageObject) AsVideoDetails 

func (ioVar ImageObject) AsVideoDetails() (*VideoDetails, bool)

AsVideoDetails is the BasicResponseBase implementation for ImageObject.

func (ImageObject) AsVideoObject 

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

AsVideoObject is the BasicResponseBase implementation for ImageObject.

func (ImageObject) AsVideos 

func (ioVar ImageObject) AsVideos() (*Videos, bool)

AsVideos 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"`
	// HostPageURL - URL of the page that hosts the media object.
	HostPageURL *string `json:"hostPageUrl,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"`
	Text     *string       `json:"text,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 *ImageObject `json:"image,omitempty"`
	// Description - A short description of the item.
	Description   *string `json:"description,omitempty"`
	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', 'TypeImageObject', 'TypeVideoObject', 'TypeVideos', 'TypeSearchResultsAnswer', 'TypeAnswer', 'TypeMediaObject', 'TypeResponse', 'TypeThing', 'TypeCreativeWork', 'TypeIdentifiable', 'TypeErrorResponse', 'TypeTrendingVideos', 'TypeVideoDetails'
	Type Type `json:"_type,omitempty"`
}

MediaObject ...

func (MediaObject) AsAnswer 

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

AsAnswer is the BasicResponseBase implementation for MediaObject.

func (MediaObject) AsBasicAnswer 

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

AsBasicAnswer 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) 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) AsTrendingVideos 

func (mo MediaObject) AsTrendingVideos() (*TrendingVideos, bool)

AsTrendingVideos is the BasicResponseBase implementation for MediaObject.

func (MediaObject) AsVideoDetails 

func (mo MediaObject) AsVideoDetails() (*VideoDetails, bool)

AsVideoDetails is the BasicResponseBase implementation for MediaObject.

func (MediaObject) AsVideoObject 

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

AsVideoObject is the BasicResponseBase implementation for MediaObject.

func (MediaObject) AsVideos 

func (mo MediaObject) AsVideos() (*Videos, bool)

AsVideos 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 PivotSuggestions 

type PivotSuggestions struct {
	Pivot       *string  `json:"pivot,omitempty"`
	Suggestions *[]Query `json:"suggestions,omitempty"`
}

PivotSuggestions ...

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   *string      `json:"searchLink,omitempty"`
	Thumbnail    *ImageObject `json:"thumbnail,omitempty"`
}

Query defines a search query.

type QueryContext 

type QueryContext struct {
	// OriginalQuery - The query string as specified in the request.
	OriginalQuery *string `json:"originalQuery,omitempty"`
	// AlteredQuery - The query string used by Bing to perform the query. Bing uses the altered query string if the original query string contained spelling mistakes. For example, if the query string is "saling downwind", the altered query string will be "sailing downwind". This field is included only if the original query string contains a spelling mistake.
	AlteredQuery *string `json:"alteredQuery,omitempty"`
	// AlterationOverrideQuery - The query string to use to force Bing to use the original string. For example, if the query string is "saling downwind", the override query string will be "+saling downwind". Remember to encode the query string which results in "%2Bsaling+downwind". This field is included only if the original query string contains a spelling mistake.
	AlterationOverrideQuery *string `json:"alterationOverrideQuery,omitempty"`
	// AdultIntent - A Boolean value that indicates whether the specified query has adult intent. The value is true if the query has adult intent; otherwise, false.
	AdultIntent *bool `json:"adultIntent,omitempty"`
	// AskUserForLocation - A Boolean value that indicates whether Bing requires the user's location to provide accurate results. If you specified the user's location by using the X-MSEdge-ClientIP and X-Search-Location headers, you can ignore this field. For location aware queries, such as "today's weather" or "restaurants near me" that need the user's location to provide accurate results, this field is set to true. For location aware queries that include the location (for example, "Seattle weather"), this field is set to false. This field is also set to false for queries that are not location aware, such as "best sellers".
	AskUserForLocation *bool `json:"askUserForLocation,omitempty"`
	IsTransactional    *bool `json:"isTransactional,omitempty"`
}

QueryContext defines the query context that Bing used for the request.

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', 'TypeImageObject', 'TypeVideoObject', 'TypeVideos', 'TypeSearchResultsAnswer', 'TypeAnswer', 'TypeMediaObject', 'TypeResponse', 'TypeThing', 'TypeCreativeWork', 'TypeIdentifiable', 'TypeErrorResponse', 'TypeTrendingVideos', 'TypeVideoDetails'
	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) AsBasicAnswer 

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

AsBasicAnswer 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) 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) AsTrendingVideos 

func (r Response) AsTrendingVideos() (*TrendingVideos, bool)

AsTrendingVideos is the BasicResponseBase implementation for Response.

func (Response) AsVideoDetails 

func (r Response) AsVideoDetails() (*VideoDetails, bool)

AsVideoDetails is the BasicResponseBase implementation for Response.

func (Response) AsVideoObject 

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

AsVideoObject is the BasicResponseBase implementation for Response.

func (Response) AsVideos 

func (r Response) AsVideos() (*Videos, bool)

AsVideos 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', 'TypeImageObject', 'TypeVideoObject', 'TypeVideos', 'TypeSearchResultsAnswer', 'TypeAnswer', 'TypeMediaObject', 'TypeResponse', 'TypeThing', 'TypeCreativeWork', 'TypeIdentifiable', 'TypeErrorResponse', 'TypeTrendingVideos', 'TypeVideoDetails'
	Type Type `json:"_type,omitempty"`
}

ResponseBase ...

func (ResponseBase) AsAnswer 

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

AsAnswer is the BasicResponseBase implementation for ResponseBase.

func (ResponseBase) AsBasicAnswer 

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

AsBasicAnswer 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) 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) AsTrendingVideos 

func (rb ResponseBase) AsTrendingVideos() (*TrendingVideos, bool)

AsTrendingVideos is the BasicResponseBase implementation for ResponseBase.

func (ResponseBase) AsVideoDetails 

func (rb ResponseBase) AsVideoDetails() (*VideoDetails, bool)

AsVideoDetails is the BasicResponseBase implementation for ResponseBase.

func (ResponseBase) AsVideoObject 

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

AsVideoObject is the BasicResponseBase implementation for ResponseBase.

func (ResponseBase) AsVideos 

func (rb ResponseBase) AsVideos() (*Videos, bool)

AsVideos 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"`
	IsFamilyFriendly      *bool    `json:"isFamilyFriendly,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', 'TypeImageObject', 'TypeVideoObject', 'TypeVideos', 'TypeSearchResultsAnswer', 'TypeAnswer', 'TypeMediaObject', 'TypeResponse', 'TypeThing', 'TypeCreativeWork', 'TypeIdentifiable', 'TypeErrorResponse', 'TypeTrendingVideos', 'TypeVideoDetails'
	Type Type `json:"_type,omitempty"`
}

SearchResultsAnswer ...

func (SearchResultsAnswer) AsAnswer 

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

AsAnswer is the BasicResponseBase implementation for SearchResultsAnswer.

func (SearchResultsAnswer) AsBasicAnswer 

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

AsBasicAnswer 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) 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) AsTrendingVideos 

func (sra SearchResultsAnswer) AsTrendingVideos() (*TrendingVideos, bool)

AsTrendingVideos is the BasicResponseBase implementation for SearchResultsAnswer.

func (SearchResultsAnswer) AsVideoDetails 

func (sra SearchResultsAnswer) AsVideoDetails() (*VideoDetails, bool)

AsVideoDetails is the BasicResponseBase implementation for SearchResultsAnswer.

func (SearchResultsAnswer) AsVideoObject 

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

AsVideoObject is the BasicResponseBase implementation for SearchResultsAnswer.

func (SearchResultsAnswer) AsVideos 

func (sra SearchResultsAnswer) AsVideos() (*Videos, bool)

AsVideos 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 *ImageObject `json:"image,omitempty"`
	// Description - A short description of the item.
	Description   *string `json:"description,omitempty"`
	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', 'TypeImageObject', 'TypeVideoObject', 'TypeVideos', 'TypeSearchResultsAnswer', 'TypeAnswer', 'TypeMediaObject', 'TypeResponse', 'TypeThing', 'TypeCreativeWork', 'TypeIdentifiable', 'TypeErrorResponse', 'TypeTrendingVideos', 'TypeVideoDetails'
	Type Type `json:"_type,omitempty"`
}

Thing ...

func (Thing) AsAnswer 

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

AsAnswer is the BasicResponseBase implementation for Thing.

func (Thing) AsBasicAnswer 

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

AsBasicAnswer 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) 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) AsTrendingVideos 

func (t Thing) AsTrendingVideos() (*TrendingVideos, bool)

AsTrendingVideos is the BasicResponseBase implementation for Thing.

func (Thing) AsVideoDetails 

func (t Thing) AsVideoDetails() (*VideoDetails, bool)

AsVideoDetails is the BasicResponseBase implementation for Thing.

func (Thing) AsVideoObject 

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

AsVideoObject is the BasicResponseBase implementation for Thing.

func (Thing) AsVideos 

func (t Thing) AsVideos() (*Videos, bool)

AsVideos is the BasicResponseBase implementation for Thing.

func (Thing) MarshalJSON 

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

MarshalJSON is the custom marshaler for Thing.

type TrendingVideos 

type TrendingVideos struct {
	autorest.Response `json:"-"`
	BannerTiles       *[]TrendingVideosTile     `json:"bannerTiles,omitempty"`
	Categories        *[]TrendingVideosCategory `json:"categories,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', 'TypeImageObject', 'TypeVideoObject', 'TypeVideos', 'TypeSearchResultsAnswer', 'TypeAnswer', 'TypeMediaObject', 'TypeResponse', 'TypeThing', 'TypeCreativeWork', 'TypeIdentifiable', 'TypeErrorResponse', 'TypeTrendingVideos', 'TypeVideoDetails'
	Type Type `json:"_type,omitempty"`
}

TrendingVideos ...

func (TrendingVideos) AsAnswer 

func (tv TrendingVideos) AsAnswer() (*Answer, bool)

AsAnswer is the BasicResponseBase implementation for TrendingVideos.

func (TrendingVideos) AsBasicAnswer 

func (tv TrendingVideos) AsBasicAnswer() (BasicAnswer, bool)

AsBasicAnswer is the BasicResponseBase implementation for TrendingVideos.

func (TrendingVideos) AsBasicCreativeWork 

func (tv TrendingVideos) AsBasicCreativeWork() (BasicCreativeWork, bool)

AsBasicCreativeWork is the BasicResponseBase implementation for TrendingVideos.

func (TrendingVideos) AsBasicIdentifiable 

func (tv TrendingVideos) AsBasicIdentifiable() (BasicIdentifiable, bool)

AsBasicIdentifiable is the BasicResponseBase implementation for TrendingVideos.

func (TrendingVideos) AsBasicMediaObject 

func (tv TrendingVideos) AsBasicMediaObject() (BasicMediaObject, bool)

AsBasicMediaObject is the BasicResponseBase implementation for TrendingVideos.

func (TrendingVideos) AsBasicResponse 

func (tv TrendingVideos) AsBasicResponse() (BasicResponse, bool)

AsBasicResponse is the BasicResponseBase implementation for TrendingVideos.

func (TrendingVideos) AsBasicResponseBase 

func (tv TrendingVideos) AsBasicResponseBase() (BasicResponseBase, bool)

AsBasicResponseBase is the BasicResponseBase implementation for TrendingVideos.

func (TrendingVideos) AsBasicSearchResultsAnswer 

func (tv TrendingVideos) AsBasicSearchResultsAnswer() (BasicSearchResultsAnswer, bool)

AsBasicSearchResultsAnswer is the BasicResponseBase implementation for TrendingVideos.

func (TrendingVideos) AsBasicThing 

func (tv TrendingVideos) AsBasicThing() (BasicThing, bool)

AsBasicThing is the BasicResponseBase implementation for TrendingVideos.

func (TrendingVideos) AsCreativeWork 

func (tv TrendingVideos) AsCreativeWork() (*CreativeWork, bool)

AsCreativeWork is the BasicResponseBase implementation for TrendingVideos.

func (TrendingVideos) AsErrorResponse 

func (tv TrendingVideos) AsErrorResponse() (*ErrorResponse, bool)

AsErrorResponse is the BasicResponseBase implementation for TrendingVideos.

func (TrendingVideos) AsIdentifiable 

func (tv TrendingVideos) AsIdentifiable() (*Identifiable, bool)

AsIdentifiable is the BasicResponseBase implementation for TrendingVideos.

func (TrendingVideos) AsImageObject 

func (tv TrendingVideos) AsImageObject() (*ImageObject, bool)

AsImageObject is the BasicResponseBase implementation for TrendingVideos.

func (TrendingVideos) AsMediaObject 

func (tv TrendingVideos) AsMediaObject() (*MediaObject, bool)

AsMediaObject is the BasicResponseBase implementation for TrendingVideos.

func (TrendingVideos) AsResponse 

func (tv TrendingVideos) AsResponse() (*Response, bool)

AsResponse is the BasicResponseBase implementation for TrendingVideos.

func (TrendingVideos) AsResponseBase 

func (tv TrendingVideos) AsResponseBase() (*ResponseBase, bool)

AsResponseBase is the BasicResponseBase implementation for TrendingVideos.

func (TrendingVideos) AsSearchResultsAnswer 

func (tv TrendingVideos) AsSearchResultsAnswer() (*SearchResultsAnswer, bool)

AsSearchResultsAnswer is the BasicResponseBase implementation for TrendingVideos.

func (TrendingVideos) AsThing 

func (tv TrendingVideos) AsThing() (*Thing, bool)

AsThing is the BasicResponseBase implementation for TrendingVideos.

func (TrendingVideos) AsTrendingVideos 

func (tv TrendingVideos) AsTrendingVideos() (*TrendingVideos, bool)

AsTrendingVideos is the BasicResponseBase implementation for TrendingVideos.

func (TrendingVideos) AsVideoDetails 

func (tv TrendingVideos) AsVideoDetails() (*VideoDetails, bool)

AsVideoDetails is the BasicResponseBase implementation for TrendingVideos.

func (TrendingVideos) AsVideoObject 

func (tv TrendingVideos) AsVideoObject() (*VideoObject, bool)

AsVideoObject is the BasicResponseBase implementation for TrendingVideos.

func (TrendingVideos) AsVideos 

func (tv TrendingVideos) AsVideos() (*Videos, bool)

AsVideos is the BasicResponseBase implementation for TrendingVideos.

func (TrendingVideos) MarshalJSON 

func (tv TrendingVideos) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for TrendingVideos.

type TrendingVideosCategory 

type TrendingVideosCategory struct {
	Title         *string                      `json:"title,omitempty"`
	Subcategories *[]TrendingVideosSubcategory `json:"subcategories,omitempty"`
}

TrendingVideosCategory ...

type TrendingVideosSubcategory 

type TrendingVideosSubcategory struct {
	Title *string               `json:"title,omitempty"`
	Tiles *[]TrendingVideosTile `json:"tiles,omitempty"`
}

TrendingVideosSubcategory ...

type TrendingVideosTile 

type TrendingVideosTile struct {
	Query *Query       `json:"query,omitempty"`
	Image *ImageObject `json:"image,omitempty"`
}

TrendingVideosTile ...

type Type 

type Type string

Type enumerates the values for type. 

const (
	// TypeAnswer ...
	TypeAnswer Type = "Answer"
	// TypeCreativeWork ...
	TypeCreativeWork Type = "CreativeWork"
	// TypeErrorResponse ...
	TypeErrorResponse Type = "ErrorResponse"
	// TypeIdentifiable ...
	TypeIdentifiable Type = "Identifiable"
	// TypeImageObject ...
	TypeImageObject Type = "ImageObject"
	// TypeMediaObject ...
	TypeMediaObject Type = "MediaObject"
	// TypeResponse ...
	TypeResponse Type = "Response"
	// TypeResponseBase ...
	TypeResponseBase Type = "ResponseBase"
	// TypeSearchResultsAnswer ...
	TypeSearchResultsAnswer Type = "SearchResultsAnswer"
	// TypeThing ...
	TypeThing Type = "Thing"
	// TypeTrendingVideos ...
	TypeTrendingVideos Type = "TrendingVideos"
	// TypeVideoDetails ...
	TypeVideoDetails Type = "VideoDetails"
	// TypeVideoObject ...
	TypeVideoObject Type = "VideoObject"
	// TypeVideos ...
	TypeVideos Type = "Videos"
)

func PossibleTypeValues 

func PossibleTypeValues() []Type

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

type VideoDetails 

type VideoDetails struct {
	autorest.Response `json:"-"`
	RelatedVideos     *VideosModule `json:"relatedVideos,omitempty"`
	VideoResult       *VideoObject  `json:"videoResult,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', 'TypeImageObject', 'TypeVideoObject', 'TypeVideos', 'TypeSearchResultsAnswer', 'TypeAnswer', 'TypeMediaObject', 'TypeResponse', 'TypeThing', 'TypeCreativeWork', 'TypeIdentifiable', 'TypeErrorResponse', 'TypeTrendingVideos', 'TypeVideoDetails'
	Type Type `json:"_type,omitempty"`
}

VideoDetails ...

func (VideoDetails) AsAnswer 

func (vd VideoDetails) AsAnswer() (*Answer, bool)

AsAnswer is the BasicResponseBase implementation for VideoDetails.

func (VideoDetails) AsBasicAnswer 

func (vd VideoDetails) AsBasicAnswer() (BasicAnswer, bool)

AsBasicAnswer is the BasicResponseBase implementation for VideoDetails.

func (VideoDetails) AsBasicCreativeWork 

func (vd VideoDetails) AsBasicCreativeWork() (BasicCreativeWork, bool)

AsBasicCreativeWork is the BasicResponseBase implementation for VideoDetails.

func (VideoDetails) AsBasicIdentifiable 

func (vd VideoDetails) AsBasicIdentifiable() (BasicIdentifiable, bool)

AsBasicIdentifiable is the BasicResponseBase implementation for VideoDetails.

func (VideoDetails) AsBasicMediaObject 

func (vd VideoDetails) AsBasicMediaObject() (BasicMediaObject, bool)

AsBasicMediaObject is the BasicResponseBase implementation for VideoDetails.

func (VideoDetails) AsBasicResponse 

func (vd VideoDetails) AsBasicResponse() (BasicResponse, bool)

AsBasicResponse is the BasicResponseBase implementation for VideoDetails.

func (VideoDetails) AsBasicResponseBase 

func (vd VideoDetails) AsBasicResponseBase() (BasicResponseBase, bool)

AsBasicResponseBase is the BasicResponseBase implementation for VideoDetails.

func (VideoDetails) AsBasicSearchResultsAnswer 

func (vd VideoDetails) AsBasicSearchResultsAnswer() (BasicSearchResultsAnswer, bool)

AsBasicSearchResultsAnswer is the BasicResponseBase implementation for VideoDetails.

func (VideoDetails) AsBasicThing 

func (vd VideoDetails) AsBasicThing() (BasicThing, bool)

AsBasicThing is the BasicResponseBase implementation for VideoDetails.

func (VideoDetails) AsCreativeWork 

func (vd VideoDetails) AsCreativeWork() (*CreativeWork, bool)

AsCreativeWork is the BasicResponseBase implementation for VideoDetails.

func (VideoDetails) AsErrorResponse 

func (vd VideoDetails) AsErrorResponse() (*ErrorResponse, bool)

AsErrorResponse is the BasicResponseBase implementation for VideoDetails.

func (VideoDetails) AsIdentifiable 

func (vd VideoDetails) AsIdentifiable() (*Identifiable, bool)

AsIdentifiable is the BasicResponseBase implementation for VideoDetails.

func (VideoDetails) AsImageObject 

func (vd VideoDetails) AsImageObject() (*ImageObject, bool)

AsImageObject is the BasicResponseBase implementation for VideoDetails.

func (VideoDetails) AsMediaObject 

func (vd VideoDetails) AsMediaObject() (*MediaObject, bool)

AsMediaObject is the BasicResponseBase implementation for VideoDetails.

func (VideoDetails) AsResponse 

func (vd VideoDetails) AsResponse() (*Response, bool)

AsResponse is the BasicResponseBase implementation for VideoDetails.

func (VideoDetails) AsResponseBase 

func (vd VideoDetails) AsResponseBase() (*ResponseBase, bool)

AsResponseBase is the BasicResponseBase implementation for VideoDetails.

func (VideoDetails) AsSearchResultsAnswer 

func (vd VideoDetails) AsSearchResultsAnswer() (*SearchResultsAnswer, bool)

AsSearchResultsAnswer is the BasicResponseBase implementation for VideoDetails.

func (VideoDetails) AsThing 

func (vd VideoDetails) AsThing() (*Thing, bool)

AsThing is the BasicResponseBase implementation for VideoDetails.

func (VideoDetails) AsTrendingVideos 

func (vd VideoDetails) AsTrendingVideos() (*TrendingVideos, bool)

AsTrendingVideos is the BasicResponseBase implementation for VideoDetails.

func (VideoDetails) AsVideoDetails 

func (vd VideoDetails) AsVideoDetails() (*VideoDetails, bool)

AsVideoDetails is the BasicResponseBase implementation for VideoDetails.

func (VideoDetails) AsVideoObject 

func (vd VideoDetails) AsVideoObject() (*VideoObject, bool)

AsVideoObject is the BasicResponseBase implementation for VideoDetails.

func (VideoDetails) AsVideos 

func (vd VideoDetails) AsVideos() (*Videos, bool)

AsVideos is the BasicResponseBase implementation for VideoDetails.

func (VideoDetails) MarshalJSON 

func (vd VideoDetails) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for VideoDetails.

type VideoInsightModule 

type VideoInsightModule string

VideoInsightModule enumerates the values for video insight module. 

const (
	// All ...
	All VideoInsightModule = "All"
	// RelatedVideos ...
	RelatedVideos VideoInsightModule = "RelatedVideos"
	// VideoResult ...
	VideoResult VideoInsightModule = "VideoResult"
)

func PossibleVideoInsightModuleValues 

func PossibleVideoInsightModuleValues() []VideoInsightModule

PossibleVideoInsightModuleValues returns an array of possible values for the VideoInsightModule const type.

type VideoLength 

type VideoLength string

VideoLength enumerates the values for video length. 

const (
	// VideoLengthAll ...
	VideoLengthAll VideoLength = "All"
	// VideoLengthLong ...
	VideoLengthLong VideoLength = "Long"
	// VideoLengthMedium ...
	VideoLengthMedium VideoLength = "Medium"
	// VideoLengthShort ...
	VideoLengthShort VideoLength = "Short"
)

func PossibleVideoLengthValues 

func PossibleVideoLengthValues() []VideoLength

PossibleVideoLengthValues returns an array of possible values for the VideoLength 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"`
	// HostPageURL - URL of the page that hosts the media object.
	HostPageURL *string `json:"hostPageUrl,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"`
	Text     *string       `json:"text,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 *ImageObject `json:"image,omitempty"`
	// Description - A short description of the item.
	Description   *string `json:"description,omitempty"`
	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', 'TypeImageObject', 'TypeVideoObject', 'TypeVideos', 'TypeSearchResultsAnswer', 'TypeAnswer', 'TypeMediaObject', 'TypeResponse', 'TypeThing', 'TypeCreativeWork', 'TypeIdentifiable', 'TypeErrorResponse', 'TypeTrendingVideos', 'TypeVideoDetails'
	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) AsBasicAnswer 

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

AsBasicAnswer 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) 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) AsTrendingVideos 

func (vo VideoObject) AsTrendingVideos() (*TrendingVideos, bool)

AsTrendingVideos is the BasicResponseBase implementation for VideoObject.

func (VideoObject) AsVideoDetails 

func (vo VideoObject) AsVideoDetails() (*VideoDetails, bool)

AsVideoDetails is the BasicResponseBase implementation for VideoObject.

func (VideoObject) AsVideoObject 

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

AsVideoObject is the BasicResponseBase implementation for VideoObject.

func (VideoObject) AsVideos 

func (vo VideoObject) AsVideos() (*Videos, bool)

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

type VideoPricing 

type VideoPricing string

VideoPricing enumerates the values for video pricing. 

const (
	// VideoPricingAll ...
	VideoPricingAll VideoPricing = "All"
	// VideoPricingFree ...
	VideoPricingFree VideoPricing = "Free"
	// VideoPricingPaid ...
	VideoPricingPaid VideoPricing = "Paid"
)

func PossibleVideoPricingValues 

func PossibleVideoPricingValues() []VideoPricing

PossibleVideoPricingValues returns an array of possible values for the VideoPricing const type.

type VideoQueryScenario 

type VideoQueryScenario string

VideoQueryScenario enumerates the values for video query scenario. 

const (
	// List ...
	List VideoQueryScenario = "List"
	// SingleDominantVideo ...
	SingleDominantVideo VideoQueryScenario = "SingleDominantVideo"
)

func PossibleVideoQueryScenarioValues 

func PossibleVideoQueryScenarioValues() []VideoQueryScenario

PossibleVideoQueryScenarioValues returns an array of possible values for the VideoQueryScenario const type.

type VideoResolution 

type VideoResolution string

VideoResolution enumerates the values for video resolution. 

const (
	// VideoResolutionAll ...
	VideoResolutionAll VideoResolution = "All"
	// VideoResolutionHD1080p ...
	VideoResolutionHD1080p VideoResolution = "HD1080p"
	// VideoResolutionHD720p ...
	VideoResolutionHD720p VideoResolution = "HD720p"
	// VideoResolutionSD480p ...
	VideoResolutionSD480p VideoResolution = "SD480p"
)

func PossibleVideoResolutionValues 

func PossibleVideoResolutionValues() []VideoResolution

PossibleVideoResolutionValues returns an array of possible values for the VideoResolution const type.

type Videos 

type Videos struct {
	autorest.Response `json:"-"`
	// Value - A list of video objects that are relevant to the query.
	Value      *[]VideoObject `json:"value,omitempty"`
	NextOffset *int32         `json:"nextOffset,omitempty"`
	// Scenario - Possible values include: 'List', 'SingleDominantVideo'
	Scenario         VideoQueryScenario  `json:"scenario,omitempty"`
	QueryExpansions  *[]Query            `json:"queryExpansions,omitempty"`
	PivotSuggestions *[]PivotSuggestions `json:"pivotSuggestions,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"`
	IsFamilyFriendly      *bool    `json:"isFamilyFriendly,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', 'TypeImageObject', 'TypeVideoObject', 'TypeVideos', 'TypeSearchResultsAnswer', 'TypeAnswer', 'TypeMediaObject', 'TypeResponse', 'TypeThing', 'TypeCreativeWork', 'TypeIdentifiable', 'TypeErrorResponse', 'TypeTrendingVideos', 'TypeVideoDetails'
	Type Type `json:"_type,omitempty"`
}

Videos defines a video answer.

func (Videos) AsAnswer 

func (vVar Videos) AsAnswer() (*Answer, bool)

AsAnswer is the BasicResponseBase implementation for Videos.

func (Videos) AsBasicAnswer 

func (vVar Videos) AsBasicAnswer() (BasicAnswer, bool)

AsBasicAnswer is the BasicResponseBase implementation for Videos.

func (Videos) AsBasicCreativeWork 

func (vVar Videos) AsBasicCreativeWork() (BasicCreativeWork, bool)

AsBasicCreativeWork is the BasicResponseBase implementation for Videos.

func (Videos) AsBasicIdentifiable 

func (vVar Videos) AsBasicIdentifiable() (BasicIdentifiable, bool)

AsBasicIdentifiable is the BasicResponseBase implementation for Videos.

func (Videos) AsBasicMediaObject 

func (vVar Videos) AsBasicMediaObject() (BasicMediaObject, bool)

AsBasicMediaObject is the BasicResponseBase implementation for Videos.

func (Videos) AsBasicResponse 

func (vVar Videos) AsBasicResponse() (BasicResponse, bool)

AsBasicResponse is the BasicResponseBase implementation for Videos.

func (Videos) AsBasicResponseBase 

func (vVar Videos) AsBasicResponseBase() (BasicResponseBase, bool)

AsBasicResponseBase is the BasicResponseBase implementation for Videos.

func (Videos) AsBasicSearchResultsAnswer 

func (vVar Videos) AsBasicSearchResultsAnswer() (BasicSearchResultsAnswer, bool)

AsBasicSearchResultsAnswer is the BasicResponseBase implementation for Videos.

func (Videos) AsBasicThing 

func (vVar Videos) AsBasicThing() (BasicThing, bool)

AsBasicThing is the BasicResponseBase implementation for Videos.

func (Videos) AsCreativeWork 

func (vVar Videos) AsCreativeWork() (*CreativeWork, bool)

AsCreativeWork is the BasicResponseBase implementation for Videos.

func (Videos) AsErrorResponse 

func (vVar Videos) AsErrorResponse() (*ErrorResponse, bool)

AsErrorResponse is the BasicResponseBase implementation for Videos.

func (Videos) AsIdentifiable 

func (vVar Videos) AsIdentifiable() (*Identifiable, bool)

AsIdentifiable is the BasicResponseBase implementation for Videos.

func (Videos) AsImageObject 

func (vVar Videos) AsImageObject() (*ImageObject, bool)

AsImageObject is the BasicResponseBase implementation for Videos.

func (Videos) AsMediaObject 

func (vVar Videos) AsMediaObject() (*MediaObject, bool)

AsMediaObject is the BasicResponseBase implementation for Videos.

func (Videos) AsResponse 

func (vVar Videos) AsResponse() (*Response, bool)

AsResponse is the BasicResponseBase implementation for Videos.

func (Videos) AsResponseBase 

func (vVar Videos) AsResponseBase() (*ResponseBase, bool)

AsResponseBase is the BasicResponseBase implementation for Videos.

func (Videos) AsSearchResultsAnswer 

func (vVar Videos) AsSearchResultsAnswer() (*SearchResultsAnswer, bool)

AsSearchResultsAnswer is the BasicResponseBase implementation for Videos.

func (Videos) AsThing 

func (vVar Videos) AsThing() (*Thing, bool)

AsThing is the BasicResponseBase implementation for Videos.

func (Videos) AsTrendingVideos 

func (vVar Videos) AsTrendingVideos() (*TrendingVideos, bool)

AsTrendingVideos is the BasicResponseBase implementation for Videos.

func (Videos) AsVideoDetails 

func (vVar Videos) AsVideoDetails() (*VideoDetails, bool)

AsVideoDetails is the BasicResponseBase implementation for Videos.

func (Videos) AsVideoObject 

func (vVar Videos) AsVideoObject() (*VideoObject, bool)

AsVideoObject is the BasicResponseBase implementation for Videos.

func (Videos) AsVideos 

func (vVar Videos) AsVideos() (*Videos, bool)

AsVideos is the BasicResponseBase implementation for Videos.

func (Videos) MarshalJSON 

func (vVar Videos) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for Videos.

type VideosClient 

type VideosClient struct {
	BaseClient
}

VideosClient is the the Video Search API lets you search on Bing for video that are relevant to the user's search query, for insights about a video or for videos that are trending based on search requests made by others. This section provides technical details about the query parameters and headers that you use to request videos and the JSON response objects that contain them. For examples that show how to make requests, see [Searching the Web for Videos](https://docs.microsoft.com/azure/cognitive-services/bing-video-search/search-the-web).

func NewVideosClient 

func NewVideosClient() VideosClient

NewVideosClient creates an instance of the VideosClient client.

func (VideosClient) Details 

func (client VideosClient) Details(ctx context.Context, query string, acceptLanguage string, userAgent string, clientID string, clientIP string, location string, countryCode string, ID string, modules []VideoInsightModule, market string, resolution VideoResolution, safeSearch SafeSearch, setLang string, textDecorations *bool, textFormat TextFormat) (result VideoDetails, err error)

Details sends the details 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 videos to a specific domain, use the [site:](http://msdn.microsoft.com/library/ff795613.aspx) operator. Use this parameter only with the Video Search API. Do not specify this parameter when calling the Trending Videos 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-video-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-video-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-video-api-v7-reference#mkt) and [setLang](https://docs.microsoft.com/en-us/rest/api/cognitiveservices/bing-video-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. ID - an ID that uniquely identifies a video. The [Video](https://docs.microsoft.com/en-us/rest/api/cognitiveservices/bing-video-api-v7-reference#video) object's videoId field contains the ID that you set this parameter to. You use this parameter to identify the video to get insights of. modules - a comma-delimited list of insights to request. The following are the possible case-insensitive values. All: Return all available insights. RelatedVideos: Return a list of videos that are similar to the video specified by the id query parameter. VideoResult: Return the video that you're requesting insights of (this is the video that you set the id query parameter to in your insights request). If you specify an insight and there is no data for it, the response object does not include the related field. For example, if you specify RelatedVideos and none exist, the response does not include the relatedVideos field. Although the user's query term is not required, you should always include it because it helps to improve relevance and the 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-video-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-video-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-video-api-v7-reference#cc) query parameter are mutually exclusive—do not specify both. resolution - filter videos by the following resolutions: SD480p: Return videos with a 480p or higher resolution. HD720p: Return videos with a 720p or higher resolution. HD1080p: Return videos with a 1080p or higher resolution. All: Do not filter by resolution.Specifying this value is the same as not specifying the resolution parameter. safeSearch - filter videos for adult content. The following are the possible filter values. Off: If the request is through the Video Search API, the response includes adult videos and the thumbnail images of the videos are clear (non-fuzzy). If the request is through the Web Search API, the response includes adult videos but the thumbnail images of the videos are pixelated (fuzzy). Moderate: If the request is through the Video Search API, the response does not include videos with adult content. If the request is through the Web Search API, the response may include videos with adult content but the thumbnail images of the videos are pixelated (fuzzy). Strict: Does not return videos with adult content. The default is Moderate. 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-video-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-video-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 (VideosClient) DetailsPreparer 

func (client VideosClient) DetailsPreparer(ctx context.Context, query string, acceptLanguage string, userAgent string, clientID string, clientIP string, location string, countryCode string, ID string, modules []VideoInsightModule, market string, resolution VideoResolution, safeSearch SafeSearch, setLang string, textDecorations *bool, textFormat TextFormat) (*http.Request, error)

DetailsPreparer prepares the Details request.

func (VideosClient) DetailsResponder 

func (client VideosClient) DetailsResponder(resp *http.Response) (result VideoDetails, err error)

DetailsResponder handles the response to the Details request. The method always closes the http.Response Body.

func (VideosClient) DetailsSender 

func (client VideosClient) DetailsSender(req *http.Request) (*http.Response, error)

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

func (VideosClient) Search 

func (client VideosClient) Search(ctx context.Context, query string, acceptLanguage string, userAgent string, clientID string, clientIP string, location string, countryCode string, count *int32, freshness Freshness, ID string, length VideoLength, market string, offset *int32, pricing VideoPricing, resolution VideoResolution, safeSearch SafeSearch, setLang string, textDecorations *bool, textFormat TextFormat) (result Videos, 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 videos to a specific domain, use the [site:](http://msdn.microsoft.com/library/ff795613.aspx) operator. Use this parameter only with the Video Search API. Do not specify this parameter when calling the Trending Videos 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-video-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-video-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-video-api-v7-reference#mkt) and [setLang](https://docs.microsoft.com/en-us/rest/api/cognitiveservices/bing-video-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 videos to return in the response. The actual number delivered may be less than requested. The default is 35. The maximum is 105. You may use this parameter along with the offset parameter to page results. For example, if your user interface presents 20 videos 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). Use this parameter only with the Video Search API. Do not specify this parameter when calling the Trending Videos API or the Web Search API. freshness - filter videos by the date and time that Bing discovered the video. The following are the possible filter values. Day: Return videos discovered within the last 24 hours. Week: Return videos discovered within the last 7 days. Month: Return videos discovered within the last 30 days. ID - an ID that uniquely identifies a video. The [Video](https://docs.microsoft.com/en-us/rest/api/cognitiveservices/bing-video-api-v7-reference#video) object's videoId field contains the ID that you set this parameter to. You use this parameter to ensure that the specified video is the first video in the list of videos that Bing returns. length - filter videos by the following lengths: Short: Return videos that are less than 5 minutes. Medium: Return videos that are between 5 and 20 minutes, inclusive. Long: Return videos that are longer than 20 minutes. All: Do not filter by length.Specifying this value is the same as not specifying the videoLength 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-video-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-video-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-video-api-v7-reference#cc) query parameter are mutually exclusive—do not specify both. offset - the zero-based offset that indicates the number of videos to skip before returning videos. The default is 0. The offset should be less than ([totalEstimatedMatches](https://docs.microsoft.com/en-us/rest/api/cognitiveservices/bing-video-api-v7-reference#videos-totalmatches) - count). Use this parameter along with the count parameter to page results. For example, if your user interface displays 20 videos 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. To prevent duplicates, see [nextOffset](https://docs.microsoft.com/en-us/rest/api/cognitiveservices/bing-video-api-v7-reference#videos-nextoffset). Use this parameter only with the Video Search API. pricing - filter videos by the following pricing options: Free: Return videos that are free to view. Paid: Return videos that require a subscription or payment to view. All: Do not filter by pricing.Specifying this value is the same as not specifying the pricing parameter. resolution - filter videos by the following resolutions: SD480p: Return videos with a 480p or higher resolution. HD720p: Return videos with a 720p or higher resolution. HD1080p: Return videos with a 1080p or higher resolution. All: Do not filter by resolution.Specifying this value is the same as not specifying the resolution parameter. safeSearch - filter videos for adult content. The following are the possible filter values. Off: If the request is through the Video Search API, the response includes adult videos and the thumbnail images of the videos are clear (non-fuzzy). If the request is through the Web Search API, the response includes adult videos but the thumbnail images of the videos are pixelated (fuzzy). Moderate: If the request is through the Video Search API, the response does not include videos with adult content. If the request is through the Web Search API, the response may include videos with adult content but the thumbnail images of the videos are pixelated (fuzzy). Strict: Does not return videos with adult content. The default is Moderate. 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-video-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-video-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 (VideosClient) SearchPreparer 

func (client VideosClient) SearchPreparer(ctx context.Context, query string, acceptLanguage string, userAgent string, clientID string, clientIP string, location string, countryCode string, count *int32, freshness Freshness, ID string, length VideoLength, market string, offset *int32, pricing VideoPricing, resolution VideoResolution, safeSearch SafeSearch, setLang string, textDecorations *bool, textFormat TextFormat) (*http.Request, error)

SearchPreparer prepares the Search request.

func (VideosClient) SearchResponder 

func (client VideosClient) SearchResponder(resp *http.Response) (result Videos, err error)

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

func (VideosClient) SearchSender 

func (client VideosClient) 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 (VideosClient) Trending 

func (client VideosClient) Trending(ctx context.Context, acceptLanguage string, userAgent string, clientID string, clientIP string, location string, countryCode string, market string, safeSearch SafeSearch, setLang string, textDecorations *bool, textFormat TextFormat) (result TrendingVideos, 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-video-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-video-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-video-api-v7-reference#mkt) and [setLang](https://docs.microsoft.com/en-us/rest/api/cognitiveservices/bing-video-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. 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-video-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-video-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-video-api-v7-reference#cc) query parameter are mutually exclusive—do not specify both. safeSearch - filter videos for adult content. The following are the possible filter values. Off: If the request is through the Video Search API, the response includes adult videos and the thumbnail images of the videos are clear (non-fuzzy). If the request is through the Web Search API, the response includes adult videos but the thumbnail images of the videos are pixelated (fuzzy). Moderate: If the request is through the Video Search API, the response does not include videos with adult content. If the request is through the Web Search API, the response may include videos with adult content but the thumbnail images of the videos are pixelated (fuzzy). Strict: Does not return videos with adult content. The default is Moderate. 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-video-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-video-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 (VideosClient) TrendingPreparer 

func (client VideosClient) TrendingPreparer(ctx context.Context, acceptLanguage string, userAgent string, clientID string, clientIP string, location string, countryCode string, market string, safeSearch SafeSearch, setLang string, textDecorations *bool, textFormat TextFormat) (*http.Request, error)

TrendingPreparer prepares the Trending request.

func (VideosClient) TrendingResponder 

func (client VideosClient) TrendingResponder(resp *http.Response) (result TrendingVideos, err error)

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

func (VideosClient) TrendingSender 

func (client VideosClient) 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 VideosModule 

type VideosModule struct {
	Value *[]VideoObject `json:"value,omitempty"`
}

VideosModule ...

Source Files

View all Source files

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.