azure-sdk-for-go: github.com/Azure/azure-sdk-for-go/services/cognitiveservices/v1.0/videosearch Index | Files | Directories

package videosearch

import "github.com/Azure/azure-sdk-for-go/services/cognitiveservices/v1.0/videosearch"

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

Package Files

client.go models.go version.go videos.go

Constants

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

func UserAgent Uses

func UserAgent() string

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

func Version Uses

func Version() string

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

type Answer Uses

type Answer struct {
    // FollowUpQueries - READ-ONLY
    FollowUpQueries *[]Query `json:"followUpQueries,omitempty"`
    // WebSearchURL - READ-ONLY; The URL To Bing's search result for this item.
    WebSearchURL *string `json:"webSearchUrl,omitempty"`
    // ID - READ-ONLY; 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 Uses

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

AsAnswer is the BasicResponseBase implementation for Answer.

func (Answer) AsBasicAnswer Uses

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

AsBasicAnswer is the BasicResponseBase implementation for Answer.

func (Answer) AsBasicCreativeWork Uses

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

AsBasicCreativeWork is the BasicResponseBase implementation for Answer.

func (Answer) AsBasicIdentifiable Uses

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

AsBasicIdentifiable is the BasicResponseBase implementation for Answer.

func (Answer) AsBasicMediaObject Uses

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

AsBasicMediaObject is the BasicResponseBase implementation for Answer.

func (Answer) AsBasicResponse Uses

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

AsBasicResponse is the BasicResponseBase implementation for Answer.

func (Answer) AsBasicResponseBase Uses

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

AsBasicResponseBase is the BasicResponseBase implementation for Answer.

func (Answer) AsBasicSearchResultsAnswer Uses

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

AsBasicSearchResultsAnswer is the BasicResponseBase implementation for Answer.

func (Answer) AsBasicThing Uses

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

AsBasicThing is the BasicResponseBase implementation for Answer.

func (Answer) AsCreativeWork Uses

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

AsCreativeWork is the BasicResponseBase implementation for Answer.

func (Answer) AsErrorResponse Uses

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

AsErrorResponse is the BasicResponseBase implementation for Answer.

func (Answer) AsIdentifiable Uses

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

AsIdentifiable is the BasicResponseBase implementation for Answer.

func (Answer) AsImageObject Uses

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

AsImageObject is the BasicResponseBase implementation for Answer.

func (Answer) AsMediaObject Uses

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

AsMediaObject is the BasicResponseBase implementation for Answer.

func (Answer) AsResponse Uses

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

AsResponse is the BasicResponseBase implementation for Answer.

func (Answer) AsResponseBase Uses

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

AsResponseBase is the BasicResponseBase implementation for Answer.

func (Answer) AsSearchResultsAnswer Uses

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

AsSearchResultsAnswer is the BasicResponseBase implementation for Answer.

func (Answer) AsThing Uses

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

AsThing is the BasicResponseBase implementation for Answer.

func (Answer) AsTrendingVideos Uses

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

AsTrendingVideos is the BasicResponseBase implementation for Answer.

func (Answer) AsVideoDetails Uses

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

AsVideoDetails is the BasicResponseBase implementation for Answer.

func (Answer) AsVideoObject Uses

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

AsVideoObject is the BasicResponseBase implementation for Answer.

func (Answer) AsVideos Uses

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

AsVideos is the BasicResponseBase implementation for Answer.

func (Answer) MarshalJSON Uses

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

MarshalJSON is the custom marshaler for Answer.

type BaseClient Uses

type BaseClient struct {
    autorest.Client
    Endpoint string
}

BaseClient is the base client for Videosearch.

func New Uses

func New() BaseClient

New creates an instance of the BaseClient client.

func NewWithoutDefaults Uses

func NewWithoutDefaults(endpoint string) BaseClient

NewWithoutDefaults creates an instance of the BaseClient client.

type BasicAnswer Uses

type BasicAnswer interface {
    AsVideos() (*Videos, bool)
    AsSearchResultsAnswer() (*SearchResultsAnswer, bool)
    AsBasicSearchResultsAnswer() (BasicSearchResultsAnswer, bool)
    AsAnswer() (*Answer, bool)
}

BasicAnswer ...

type BasicCreativeWork Uses

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

BasicCreativeWork ...

type BasicIdentifiable Uses

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 Uses

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

BasicMediaObject ...

type BasicResponse Uses

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 Uses

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 Uses

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

BasicSearchResultsAnswer ...

type BasicThing Uses

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 Uses

type CreativeWork struct {
    // ThumbnailURL - READ-ONLY; The URL to a thumbnail of the item.
    ThumbnailURL *string `json:"thumbnailUrl,omitempty"`
    // Provider - READ-ONLY; The source of the creative work.
    Provider *[]BasicThing `json:"provider,omitempty"`
    // Text - READ-ONLY
    Text *string `json:"text,omitempty"`
    // Name - READ-ONLY; The name of the thing represented by this object.
    Name *string `json:"name,omitempty"`
    // URL - READ-ONLY; The URL to get more information about the thing represented by this object.
    URL *string `json:"url,omitempty"`
    // Image - READ-ONLY
    Image *ImageObject `json:"image,omitempty"`
    // Description - READ-ONLY; A short description of the item.
    Description *string `json:"description,omitempty"`
    // AlternateName - READ-ONLY
    AlternateName *string `json:"alternateName,omitempty"`
    // BingID - READ-ONLY; An ID that uniquely identifies this item.
    BingID *string `json:"bingId,omitempty"`
    // WebSearchURL - READ-ONLY; The URL To Bing's search result for this item.
    WebSearchURL *string `json:"webSearchUrl,omitempty"`
    // ID - READ-ONLY; 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 Uses

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

AsAnswer is the BasicResponseBase implementation for CreativeWork.

func (CreativeWork) AsBasicAnswer Uses

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

AsBasicAnswer is the BasicResponseBase implementation for CreativeWork.

func (CreativeWork) AsBasicCreativeWork Uses

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

AsBasicCreativeWork is the BasicResponseBase implementation for CreativeWork.

func (CreativeWork) AsBasicIdentifiable Uses

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

AsBasicIdentifiable is the BasicResponseBase implementation for CreativeWork.

func (CreativeWork) AsBasicMediaObject Uses

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

AsBasicMediaObject is the BasicResponseBase implementation for CreativeWork.

func (CreativeWork) AsBasicResponse Uses

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

AsBasicResponse is the BasicResponseBase implementation for CreativeWork.

func (CreativeWork) AsBasicResponseBase Uses

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

AsBasicResponseBase is the BasicResponseBase implementation for CreativeWork.

func (CreativeWork) AsBasicSearchResultsAnswer Uses

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

AsBasicSearchResultsAnswer is the BasicResponseBase implementation for CreativeWork.

func (CreativeWork) AsBasicThing Uses

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

AsBasicThing is the BasicResponseBase implementation for CreativeWork.

func (CreativeWork) AsCreativeWork Uses

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

AsCreativeWork is the BasicResponseBase implementation for CreativeWork.

func (CreativeWork) AsErrorResponse Uses

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

AsErrorResponse is the BasicResponseBase implementation for CreativeWork.

func (CreativeWork) AsIdentifiable Uses

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

AsIdentifiable is the BasicResponseBase implementation for CreativeWork.

func (CreativeWork) AsImageObject Uses

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

AsImageObject is the BasicResponseBase implementation for CreativeWork.

func (CreativeWork) AsMediaObject Uses

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

AsMediaObject is the BasicResponseBase implementation for CreativeWork.

func (CreativeWork) AsResponse Uses

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

AsResponse is the BasicResponseBase implementation for CreativeWork.

func (CreativeWork) AsResponseBase Uses

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

AsResponseBase is the BasicResponseBase implementation for CreativeWork.

func (CreativeWork) AsSearchResultsAnswer Uses

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

AsSearchResultsAnswer is the BasicResponseBase implementation for CreativeWork.

func (CreativeWork) AsThing Uses

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

AsThing is the BasicResponseBase implementation for CreativeWork.

func (CreativeWork) AsTrendingVideos Uses

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

AsTrendingVideos is the BasicResponseBase implementation for CreativeWork.

func (CreativeWork) AsVideoDetails Uses

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

AsVideoDetails is the BasicResponseBase implementation for CreativeWork.

func (CreativeWork) AsVideoObject Uses

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

AsVideoObject is the BasicResponseBase implementation for CreativeWork.

func (CreativeWork) AsVideos Uses

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

AsVideos is the BasicResponseBase implementation for CreativeWork.

func (CreativeWork) MarshalJSON Uses

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

MarshalJSON is the custom marshaler for CreativeWork.

func (*CreativeWork) UnmarshalJSON Uses

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

UnmarshalJSON is the custom unmarshaler for CreativeWork struct.

type Error Uses

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 - READ-ONLY; 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 - READ-ONLY; A description that provides additional information about the error.
    MoreDetails *string `json:"moreDetails,omitempty"`
    // Parameter - READ-ONLY; The parameter in the request that caused the error.
    Parameter *string `json:"parameter,omitempty"`
    // Value - READ-ONLY; The parameter's value in the request that was not valid.
    Value *string `json:"value,omitempty"`
}

Error defines the error that occurred.

type ErrorCode Uses

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 Uses

func PossibleErrorCodeValues() []ErrorCode

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

type ErrorResponse Uses

type ErrorResponse struct {
    // Errors - A list of errors that describe the reasons why the request failed.
    Errors *[]Error `json:"errors,omitempty"`
    // WebSearchURL - READ-ONLY; The URL To Bing's search result for this item.
    WebSearchURL *string `json:"webSearchUrl,omitempty"`
    // ID - READ-ONLY; 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 Uses

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

AsAnswer is the BasicResponseBase implementation for ErrorResponse.

func (ErrorResponse) AsBasicAnswer Uses

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

AsBasicAnswer is the BasicResponseBase implementation for ErrorResponse.

func (ErrorResponse) AsBasicCreativeWork Uses

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

AsBasicCreativeWork is the BasicResponseBase implementation for ErrorResponse.

func (ErrorResponse) AsBasicIdentifiable Uses

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

AsBasicIdentifiable is the BasicResponseBase implementation for ErrorResponse.

func (ErrorResponse) AsBasicMediaObject Uses

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

AsBasicMediaObject is the BasicResponseBase implementation for ErrorResponse.

func (ErrorResponse) AsBasicResponse Uses

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

AsBasicResponse is the BasicResponseBase implementation for ErrorResponse.

func (ErrorResponse) AsBasicResponseBase Uses

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

AsBasicResponseBase is the BasicResponseBase implementation for ErrorResponse.

func (ErrorResponse) AsBasicSearchResultsAnswer Uses

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

AsBasicSearchResultsAnswer is the BasicResponseBase implementation for ErrorResponse.

func (ErrorResponse) AsBasicThing Uses

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

AsBasicThing is the BasicResponseBase implementation for ErrorResponse.

func (ErrorResponse) AsCreativeWork Uses

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

AsCreativeWork is the BasicResponseBase implementation for ErrorResponse.

func (ErrorResponse) AsErrorResponse Uses

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

AsErrorResponse is the BasicResponseBase implementation for ErrorResponse.

func (ErrorResponse) AsIdentifiable Uses

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

AsIdentifiable is the BasicResponseBase implementation for ErrorResponse.

func (ErrorResponse) AsImageObject Uses

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

AsImageObject is the BasicResponseBase implementation for ErrorResponse.

func (ErrorResponse) AsMediaObject Uses

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

AsMediaObject is the BasicResponseBase implementation for ErrorResponse.

func (ErrorResponse) AsResponse Uses

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

AsResponse is the BasicResponseBase implementation for ErrorResponse.

func (ErrorResponse) AsResponseBase Uses

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

AsResponseBase is the BasicResponseBase implementation for ErrorResponse.

func (ErrorResponse) AsSearchResultsAnswer Uses

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

AsSearchResultsAnswer is the BasicResponseBase implementation for ErrorResponse.

func (ErrorResponse) AsThing Uses

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

AsThing is the BasicResponseBase implementation for ErrorResponse.

func (ErrorResponse) AsTrendingVideos Uses

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

AsTrendingVideos is the BasicResponseBase implementation for ErrorResponse.

func (ErrorResponse) AsVideoDetails Uses

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

AsVideoDetails is the BasicResponseBase implementation for ErrorResponse.

func (ErrorResponse) AsVideoObject Uses

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

AsVideoObject is the BasicResponseBase implementation for ErrorResponse.

func (ErrorResponse) AsVideos Uses

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

AsVideos is the BasicResponseBase implementation for ErrorResponse.

func (ErrorResponse) MarshalJSON Uses

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

MarshalJSON is the custom marshaler for ErrorResponse.

type ErrorSubCode Uses

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 Uses

func PossibleErrorSubCodeValues() []ErrorSubCode

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

type Freshness Uses

type Freshness string

Freshness enumerates the values for freshness.

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

func PossibleFreshnessValues Uses

func PossibleFreshnessValues() []Freshness

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

type Identifiable Uses

type Identifiable struct {
    // ID - READ-ONLY; 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 Uses

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

AsAnswer is the BasicResponseBase implementation for Identifiable.

func (Identifiable) AsBasicAnswer Uses

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

AsBasicAnswer is the BasicResponseBase implementation for Identifiable.

func (Identifiable) AsBasicCreativeWork Uses

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

AsBasicCreativeWork is the BasicResponseBase implementation for Identifiable.

func (Identifiable) AsBasicIdentifiable Uses

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

AsBasicIdentifiable is the BasicResponseBase implementation for Identifiable.

func (Identifiable) AsBasicMediaObject Uses

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

AsBasicMediaObject is the BasicResponseBase implementation for Identifiable.

func (Identifiable) AsBasicResponse Uses

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

AsBasicResponse is the BasicResponseBase implementation for Identifiable.

func (Identifiable) AsBasicResponseBase Uses

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

AsBasicResponseBase is the BasicResponseBase implementation for Identifiable.

func (Identifiable) AsBasicSearchResultsAnswer Uses

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

AsBasicSearchResultsAnswer is the BasicResponseBase implementation for Identifiable.

func (Identifiable) AsBasicThing Uses

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

AsBasicThing is the BasicResponseBase implementation for Identifiable.

func (Identifiable) AsCreativeWork Uses

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

AsCreativeWork is the BasicResponseBase implementation for Identifiable.

func (Identifiable) AsErrorResponse Uses

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

AsErrorResponse is the BasicResponseBase implementation for Identifiable.

func (Identifiable) AsIdentifiable Uses

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

AsIdentifiable is the BasicResponseBase implementation for Identifiable.

func (Identifiable) AsImageObject Uses

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

AsImageObject is the BasicResponseBase implementation for Identifiable.

func (Identifiable) AsMediaObject Uses

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

AsMediaObject is the BasicResponseBase implementation for Identifiable.

func (Identifiable) AsResponse Uses

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

AsResponse is the BasicResponseBase implementation for Identifiable.

func (Identifiable) AsResponseBase Uses

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

AsResponseBase is the BasicResponseBase implementation for Identifiable.

func (Identifiable) AsSearchResultsAnswer Uses

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

AsSearchResultsAnswer is the BasicResponseBase implementation for Identifiable.

func (Identifiable) AsThing Uses

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

AsThing is the BasicResponseBase implementation for Identifiable.

func (Identifiable) AsTrendingVideos Uses

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

AsTrendingVideos is the BasicResponseBase implementation for Identifiable.

func (Identifiable) AsVideoDetails Uses

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

AsVideoDetails is the BasicResponseBase implementation for Identifiable.

func (Identifiable) AsVideoObject Uses

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

AsVideoObject is the BasicResponseBase implementation for Identifiable.

func (Identifiable) AsVideos Uses

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

AsVideos is the BasicResponseBase implementation for Identifiable.

func (Identifiable) MarshalJSON Uses

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

MarshalJSON is the custom marshaler for Identifiable.

type ImageObject Uses

type ImageObject struct {
    // Thumbnail - READ-ONLY; The URL to a thumbnail of the image
    Thumbnail *ImageObject `json:"thumbnail,omitempty"`
    // ContentURL - READ-ONLY; 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 - READ-ONLY; URL of the page that hosts the media object.
    HostPageURL *string `json:"hostPageUrl,omitempty"`
    // Width - READ-ONLY; The width of the source media object, in pixels.
    Width *int32 `json:"width,omitempty"`
    // Height - READ-ONLY; The height of the source media object, in pixels.
    Height *int32 `json:"height,omitempty"`
    // ThumbnailURL - READ-ONLY; The URL to a thumbnail of the item.
    ThumbnailURL *string `json:"thumbnailUrl,omitempty"`
    // Provider - READ-ONLY; The source of the creative work.
    Provider *[]BasicThing `json:"provider,omitempty"`
    // Text - READ-ONLY
    Text *string `json:"text,omitempty"`
    // Name - READ-ONLY; The name of the thing represented by this object.
    Name *string `json:"name,omitempty"`
    // URL - READ-ONLY; The URL to get more information about the thing represented by this object.
    URL *string `json:"url,omitempty"`
    // Image - READ-ONLY
    Image *ImageObject `json:"image,omitempty"`
    // Description - READ-ONLY; A short description of the item.
    Description *string `json:"description,omitempty"`
    // AlternateName - READ-ONLY
    AlternateName *string `json:"alternateName,omitempty"`
    // BingID - READ-ONLY; An ID that uniquely identifies this item.
    BingID *string `json:"bingId,omitempty"`
    // WebSearchURL - READ-ONLY; The URL To Bing's search result for this item.
    WebSearchURL *string `json:"webSearchUrl,omitempty"`
    // ID - READ-ONLY; 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 Uses

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

AsAnswer is the BasicResponseBase implementation for ImageObject.

func (ImageObject) AsBasicAnswer Uses

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

AsBasicAnswer is the BasicResponseBase implementation for ImageObject.

func (ImageObject) AsBasicCreativeWork Uses

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

AsBasicCreativeWork is the BasicResponseBase implementation for ImageObject.

func (ImageObject) AsBasicIdentifiable Uses

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

AsBasicIdentifiable is the BasicResponseBase implementation for ImageObject.

func (ImageObject) AsBasicMediaObject Uses

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

AsBasicMediaObject is the BasicResponseBase implementation for ImageObject.

func (ImageObject) AsBasicResponse Uses

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

AsBasicResponse is the BasicResponseBase implementation for ImageObject.

func (ImageObject) AsBasicResponseBase Uses

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

AsBasicResponseBase is the BasicResponseBase implementation for ImageObject.

func (ImageObject) AsBasicSearchResultsAnswer Uses

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

AsBasicSearchResultsAnswer is the BasicResponseBase implementation for ImageObject.

func (ImageObject) AsBasicThing Uses

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

AsBasicThing is the BasicResponseBase implementation for ImageObject.

func (ImageObject) AsCreativeWork Uses

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

AsCreativeWork is the BasicResponseBase implementation for ImageObject.

func (ImageObject) AsErrorResponse Uses

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

AsErrorResponse is the BasicResponseBase implementation for ImageObject.

func (ImageObject) AsIdentifiable Uses

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

AsIdentifiable is the BasicResponseBase implementation for ImageObject.

func (ImageObject) AsImageObject Uses

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

AsImageObject is the BasicResponseBase implementation for ImageObject.

func (ImageObject) AsMediaObject Uses

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

AsMediaObject is the BasicResponseBase implementation for ImageObject.

func (ImageObject) AsResponse Uses

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

AsResponse is the BasicResponseBase implementation for ImageObject.

func (ImageObject) AsResponseBase Uses

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

AsResponseBase is the BasicResponseBase implementation for ImageObject.

func (ImageObject) AsSearchResultsAnswer Uses

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

AsSearchResultsAnswer is the BasicResponseBase implementation for ImageObject.

func (ImageObject) AsThing Uses

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

AsThing is the BasicResponseBase implementation for ImageObject.

func (ImageObject) AsTrendingVideos Uses

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

AsTrendingVideos is the BasicResponseBase implementation for ImageObject.

func (ImageObject) AsVideoDetails Uses

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

AsVideoDetails is the BasicResponseBase implementation for ImageObject.

func (ImageObject) AsVideoObject Uses

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

AsVideoObject is the BasicResponseBase implementation for ImageObject.

func (ImageObject) AsVideos Uses

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

AsVideos is the BasicResponseBase implementation for ImageObject.

func (ImageObject) MarshalJSON Uses

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

MarshalJSON is the custom marshaler for ImageObject.

func (*ImageObject) UnmarshalJSON Uses

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

UnmarshalJSON is the custom unmarshaler for ImageObject struct.

type MediaObject Uses

type MediaObject struct {
    // ContentURL - READ-ONLY; 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 - READ-ONLY; URL of the page that hosts the media object.
    HostPageURL *string `json:"hostPageUrl,omitempty"`
    // Width - READ-ONLY; The width of the source media object, in pixels.
    Width *int32 `json:"width,omitempty"`
    // Height - READ-ONLY; The height of the source media object, in pixels.
    Height *int32 `json:"height,omitempty"`
    // ThumbnailURL - READ-ONLY; The URL to a thumbnail of the item.
    ThumbnailURL *string `json:"thumbnailUrl,omitempty"`
    // Provider - READ-ONLY; The source of the creative work.
    Provider *[]BasicThing `json:"provider,omitempty"`
    // Text - READ-ONLY
    Text *string `json:"text,omitempty"`
    // Name - READ-ONLY; The name of the thing represented by this object.
    Name *string `json:"name,omitempty"`
    // URL - READ-ONLY; The URL to get more information about the thing represented by this object.
    URL *string `json:"url,omitempty"`
    // Image - READ-ONLY
    Image *ImageObject `json:"image,omitempty"`
    // Description - READ-ONLY; A short description of the item.
    Description *string `json:"description,omitempty"`
    // AlternateName - READ-ONLY
    AlternateName *string `json:"alternateName,omitempty"`
    // BingID - READ-ONLY; An ID that uniquely identifies this item.
    BingID *string `json:"bingId,omitempty"`
    // WebSearchURL - READ-ONLY; The URL To Bing's search result for this item.
    WebSearchURL *string `json:"webSearchUrl,omitempty"`
    // ID - READ-ONLY; 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 Uses

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

AsAnswer is the BasicResponseBase implementation for MediaObject.

func (MediaObject) AsBasicAnswer Uses

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

AsBasicAnswer is the BasicResponseBase implementation for MediaObject.

func (MediaObject) AsBasicCreativeWork Uses

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

AsBasicCreativeWork is the BasicResponseBase implementation for MediaObject.

func (MediaObject) AsBasicIdentifiable Uses

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

AsBasicIdentifiable is the BasicResponseBase implementation for MediaObject.

func (MediaObject) AsBasicMediaObject Uses

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

AsBasicMediaObject is the BasicResponseBase implementation for MediaObject.

func (MediaObject) AsBasicResponse Uses

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

AsBasicResponse is the BasicResponseBase implementation for MediaObject.

func (MediaObject) AsBasicResponseBase Uses

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

AsBasicResponseBase is the BasicResponseBase implementation for MediaObject.

func (MediaObject) AsBasicSearchResultsAnswer Uses

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

AsBasicSearchResultsAnswer is the BasicResponseBase implementation for MediaObject.

func (MediaObject) AsBasicThing Uses

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

AsBasicThing is the BasicResponseBase implementation for MediaObject.

func (MediaObject) AsCreativeWork Uses

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

AsCreativeWork is the BasicResponseBase implementation for MediaObject.

func (MediaObject) AsErrorResponse Uses

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

AsErrorResponse is the BasicResponseBase implementation for MediaObject.

func (MediaObject) AsIdentifiable Uses

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

AsIdentifiable is the BasicResponseBase implementation for MediaObject.

func (MediaObject) AsImageObject Uses

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

AsImageObject is the BasicResponseBase implementation for MediaObject.

func (MediaObject) AsMediaObject Uses

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

AsMediaObject is the BasicResponseBase implementation for MediaObject.

func (MediaObject) AsResponse Uses

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

AsResponse is the BasicResponseBase implementation for MediaObject.

func (MediaObject) AsResponseBase Uses

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

AsResponseBase is the BasicResponseBase implementation for MediaObject.

func (MediaObject) AsSearchResultsAnswer Uses

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

AsSearchResultsAnswer is the BasicResponseBase implementation for MediaObject.

func (MediaObject) AsThing Uses

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

AsThing is the BasicResponseBase implementation for MediaObject.

func (MediaObject) AsTrendingVideos Uses

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

AsTrendingVideos is the BasicResponseBase implementation for MediaObject.

func (MediaObject) AsVideoDetails Uses

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

AsVideoDetails is the BasicResponseBase implementation for MediaObject.

func (MediaObject) AsVideoObject Uses

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

AsVideoObject is the BasicResponseBase implementation for MediaObject.

func (MediaObject) AsVideos Uses

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

AsVideos is the BasicResponseBase implementation for MediaObject.

func (MediaObject) MarshalJSON Uses

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

MarshalJSON is the custom marshaler for MediaObject.

func (*MediaObject) UnmarshalJSON Uses

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

UnmarshalJSON is the custom unmarshaler for MediaObject struct.

type PivotSuggestions Uses

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

PivotSuggestions ...

type Query Uses

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

Query defines a search query.

type QueryContext Uses

type QueryContext struct {
    // OriginalQuery - The query string as specified in the request.
    OriginalQuery *string `json:"originalQuery,omitempty"`
    // AlteredQuery - READ-ONLY; 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 - READ-ONLY; 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 - READ-ONLY; 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 - READ-ONLY; 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 - READ-ONLY
    IsTransactional *bool `json:"isTransactional,omitempty"`
}

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

type Response Uses

type Response struct {
    // WebSearchURL - READ-ONLY; The URL To Bing's search result for this item.
    WebSearchURL *string `json:"webSearchUrl,omitempty"`
    // ID - READ-ONLY; 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 Uses

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

AsAnswer is the BasicResponseBase implementation for Response.

func (Response) AsBasicAnswer Uses

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

AsBasicAnswer is the BasicResponseBase implementation for Response.

func (Response) AsBasicCreativeWork Uses

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

AsBasicCreativeWork is the BasicResponseBase implementation for Response.

func (Response) AsBasicIdentifiable Uses

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

AsBasicIdentifiable is the BasicResponseBase implementation for Response.

func (Response) AsBasicMediaObject Uses

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

AsBasicMediaObject is the BasicResponseBase implementation for Response.

func (Response) AsBasicResponse Uses

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

AsBasicResponse is the BasicResponseBase implementation for Response.

func (Response) AsBasicResponseBase Uses

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

AsBasicResponseBase is the BasicResponseBase implementation for Response.

func (Response) AsBasicSearchResultsAnswer Uses

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

AsBasicSearchResultsAnswer is the BasicResponseBase implementation for Response.

func (Response) AsBasicThing Uses

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

AsBasicThing is the BasicResponseBase implementation for Response.

func (Response) AsCreativeWork Uses

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

AsCreativeWork is the BasicResponseBase implementation for Response.

func (Response) AsErrorResponse Uses

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

AsErrorResponse is the BasicResponseBase implementation for Response.

func (Response) AsIdentifiable Uses

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

AsIdentifiable is the BasicResponseBase implementation for Response.

func (Response) AsImageObject Uses

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

AsImageObject is the BasicResponseBase implementation for Response.

func (Response) AsMediaObject Uses

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

AsMediaObject is the BasicResponseBase implementation for Response.

func (Response) AsResponse Uses

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

AsResponse is the BasicResponseBase implementation for Response.

func (Response) AsResponseBase Uses

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

AsResponseBase is the BasicResponseBase implementation for Response.

func (Response) AsSearchResultsAnswer Uses

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

AsSearchResultsAnswer is the BasicResponseBase implementation for Response.

func (Response) AsThing Uses

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

AsThing is the BasicResponseBase implementation for Response.

func (Response) AsTrendingVideos Uses

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

AsTrendingVideos is the BasicResponseBase implementation for Response.

func (Response) AsVideoDetails Uses

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

AsVideoDetails is the BasicResponseBase implementation for Response.

func (Response) AsVideoObject Uses

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

AsVideoObject is the BasicResponseBase implementation for Response.

func (Response) AsVideos Uses

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

AsVideos is the BasicResponseBase implementation for Response.

func (Response) MarshalJSON Uses

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

MarshalJSON is the custom marshaler for Response.

type ResponseBase Uses

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 Uses

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

AsAnswer is the BasicResponseBase implementation for ResponseBase.

func (ResponseBase) AsBasicAnswer Uses

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

AsBasicAnswer is the BasicResponseBase implementation for ResponseBase.

func (ResponseBase) AsBasicCreativeWork Uses

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

AsBasicCreativeWork is the BasicResponseBase implementation for ResponseBase.

func (ResponseBase) AsBasicIdentifiable Uses

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

AsBasicIdentifiable is the BasicResponseBase implementation for ResponseBase.

func (ResponseBase) AsBasicMediaObject Uses

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

AsBasicMediaObject is the BasicResponseBase implementation for ResponseBase.

func (ResponseBase) AsBasicResponse Uses

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

AsBasicResponse is the BasicResponseBase implementation for ResponseBase.

func (ResponseBase) AsBasicResponseBase Uses

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

AsBasicResponseBase is the BasicResponseBase implementation for ResponseBase.

func (ResponseBase) AsBasicSearchResultsAnswer Uses

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

AsBasicSearchResultsAnswer is the BasicResponseBase implementation for ResponseBase.

func (ResponseBase) AsBasicThing Uses

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

AsBasicThing is the BasicResponseBase implementation for ResponseBase.

func (ResponseBase) AsCreativeWork Uses

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

AsCreativeWork is the BasicResponseBase implementation for ResponseBase.

func (ResponseBase) AsErrorResponse Uses

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

AsErrorResponse is the BasicResponseBase implementation for ResponseBase.

func (ResponseBase) AsIdentifiable Uses

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

AsIdentifiable is the BasicResponseBase implementation for ResponseBase.

func (ResponseBase) AsImageObject Uses

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

AsImageObject is the BasicResponseBase implementation for ResponseBase.

func (ResponseBase) AsMediaObject Uses

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

AsMediaObject is the BasicResponseBase implementation for ResponseBase.

func (ResponseBase) AsResponse Uses

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

AsResponse is the BasicResponseBase implementation for ResponseBase.

func (ResponseBase) AsResponseBase Uses

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

AsResponseBase is the BasicResponseBase implementation for ResponseBase.

func (ResponseBase) AsSearchResultsAnswer Uses

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

AsSearchResultsAnswer is the BasicResponseBase implementation for ResponseBase.

func (ResponseBase) AsThing Uses

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

AsThing is the BasicResponseBase implementation for ResponseBase.

func (ResponseBase) AsTrendingVideos Uses

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

AsTrendingVideos is the BasicResponseBase implementation for ResponseBase.

func (ResponseBase) AsVideoDetails Uses

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

AsVideoDetails is the BasicResponseBase implementation for ResponseBase.

func (ResponseBase) AsVideoObject Uses

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

AsVideoObject is the BasicResponseBase implementation for ResponseBase.

func (ResponseBase) AsVideos Uses

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

AsVideos is the BasicResponseBase implementation for ResponseBase.

func (ResponseBase) MarshalJSON Uses

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

MarshalJSON is the custom marshaler for ResponseBase.

type SafeSearch Uses

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 Uses

func PossibleSafeSearchValues() []SafeSearch

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

type SearchResultsAnswer Uses

type SearchResultsAnswer struct {
    // TotalEstimatedMatches - READ-ONLY; 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 - READ-ONLY
    IsFamilyFriendly *bool `json:"isFamilyFriendly,omitempty"`
    // FollowUpQueries - READ-ONLY
    FollowUpQueries *[]Query `json:"followUpQueries,omitempty"`
    // WebSearchURL - READ-ONLY; The URL To Bing's search result for this item.
    WebSearchURL *string `json:"webSearchUrl,omitempty"`
    // ID - READ-ONLY; 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 Uses

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

AsAnswer is the BasicResponseBase implementation for SearchResultsAnswer.

func (SearchResultsAnswer) AsBasicAnswer Uses

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

AsBasicAnswer is the BasicResponseBase implementation for SearchResultsAnswer.

func (SearchResultsAnswer) AsBasicCreativeWork Uses

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

AsBasicCreativeWork is the BasicResponseBase implementation for SearchResultsAnswer.

func (SearchResultsAnswer) AsBasicIdentifiable Uses

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

AsBasicIdentifiable is the BasicResponseBase implementation for SearchResultsAnswer.

func (SearchResultsAnswer) AsBasicMediaObject Uses

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

AsBasicMediaObject is the BasicResponseBase implementation for SearchResultsAnswer.

func (SearchResultsAnswer) AsBasicResponse Uses

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

AsBasicResponse is the BasicResponseBase implementation for SearchResultsAnswer.

func (SearchResultsAnswer) AsBasicResponseBase Uses

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

AsBasicResponseBase is the BasicResponseBase implementation for SearchResultsAnswer.

func (SearchResultsAnswer) AsBasicSearchResultsAnswer Uses

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

AsBasicSearchResultsAnswer is the BasicResponseBase implementation for SearchResultsAnswer.

func (SearchResultsAnswer) AsBasicThing Uses

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

AsBasicThing is the BasicResponseBase implementation for SearchResultsAnswer.

func (SearchResultsAnswer) AsCreativeWork Uses

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

AsCreativeWork is the BasicResponseBase implementation for SearchResultsAnswer.

func (SearchResultsAnswer) AsErrorResponse Uses

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

AsErrorResponse is the BasicResponseBase implementation for SearchResultsAnswer.

func (SearchResultsAnswer) AsIdentifiable Uses

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

AsIdentifiable is the BasicResponseBase implementation for SearchResultsAnswer.

func (SearchResultsAnswer) AsImageObject Uses

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

AsImageObject is the BasicResponseBase implementation for SearchResultsAnswer.

func (SearchResultsAnswer) AsMediaObject Uses

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

AsMediaObject is the BasicResponseBase implementation for SearchResultsAnswer.

func (SearchResultsAnswer) AsResponse Uses

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

AsResponse is the BasicResponseBase implementation for SearchResultsAnswer.

func (SearchResultsAnswer) AsResponseBase Uses

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

AsResponseBase is the BasicResponseBase implementation for SearchResultsAnswer.

func (SearchResultsAnswer) AsSearchResultsAnswer Uses

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

AsSearchResultsAnswer is the BasicResponseBase implementation for SearchResultsAnswer.

func (SearchResultsAnswer) AsThing Uses

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

AsThing is the BasicResponseBase implementation for SearchResultsAnswer.

func (SearchResultsAnswer) AsTrendingVideos Uses

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

AsTrendingVideos is the BasicResponseBase implementation for SearchResultsAnswer.

func (SearchResultsAnswer) AsVideoDetails Uses

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

AsVideoDetails is the BasicResponseBase implementation for SearchResultsAnswer.

func (SearchResultsAnswer) AsVideoObject Uses

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

AsVideoObject is the BasicResponseBase implementation for SearchResultsAnswer.

func (SearchResultsAnswer) AsVideos Uses

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

AsVideos is the BasicResponseBase implementation for SearchResultsAnswer.

func (SearchResultsAnswer) MarshalJSON Uses

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

MarshalJSON is the custom marshaler for SearchResultsAnswer.

type TextFormat Uses

type TextFormat string

TextFormat enumerates the values for text format.

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

func PossibleTextFormatValues Uses

func PossibleTextFormatValues() []TextFormat

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

type Thing Uses

type Thing struct {
    // Name - READ-ONLY; The name of the thing represented by this object.
    Name *string `json:"name,omitempty"`
    // URL - READ-ONLY; The URL to get more information about the thing represented by this object.
    URL *string `json:"url,omitempty"`
    // Image - READ-ONLY
    Image *ImageObject `json:"image,omitempty"`
    // Description - READ-ONLY; A short description of the item.
    Description *string `json:"description,omitempty"`
    // AlternateName - READ-ONLY
    AlternateName *string `json:"alternateName,omitempty"`
    // BingID - READ-ONLY; An ID that uniquely identifies this item.
    BingID *string `json:"bingId,omitempty"`
    // WebSearchURL - READ-ONLY; The URL To Bing's search result for this item.
    WebSearchURL *string `json:"webSearchUrl,omitempty"`
    // ID - READ-ONLY; 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 Uses

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

AsAnswer is the BasicResponseBase implementation for Thing.

func (Thing) AsBasicAnswer Uses

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

AsBasicAnswer is the BasicResponseBase implementation for Thing.

func (Thing) AsBasicCreativeWork Uses

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

AsBasicCreativeWork is the BasicResponseBase implementation for Thing.

func (Thing) AsBasicIdentifiable Uses

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

AsBasicIdentifiable is the BasicResponseBase implementation for Thing.

func (Thing) AsBasicMediaObject Uses

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

AsBasicMediaObject is the BasicResponseBase implementation for Thing.

func (Thing) AsBasicResponse Uses

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

AsBasicResponse is the BasicResponseBase implementation for Thing.

func (Thing) AsBasicResponseBase Uses

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

AsBasicResponseBase is the BasicResponseBase implementation for Thing.

func (Thing) AsBasicSearchResultsAnswer Uses

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

AsBasicSearchResultsAnswer is the BasicResponseBase implementation for Thing.

func (Thing) AsBasicThing Uses

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

AsBasicThing is the BasicResponseBase implementation for Thing.

func (Thing) AsCreativeWork Uses

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

AsCreativeWork is the BasicResponseBase implementation for Thing.

func (Thing) AsErrorResponse Uses

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

AsErrorResponse is the BasicResponseBase implementation for Thing.

func (Thing) AsIdentifiable Uses

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

AsIdentifiable is the BasicResponseBase implementation for Thing.

func (Thing) AsImageObject Uses

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

AsImageObject is the BasicResponseBase implementation for Thing.

func (Thing) AsMediaObject Uses

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

AsMediaObject is the BasicResponseBase implementation for Thing.

func (Thing) AsResponse Uses

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

AsResponse is the BasicResponseBase implementation for Thing.

func (Thing) AsResponseBase Uses

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

AsResponseBase is the BasicResponseBase implementation for Thing.

func (Thing) AsSearchResultsAnswer Uses

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

AsSearchResultsAnswer is the BasicResponseBase implementation for Thing.

func (Thing) AsThing Uses

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

AsThing is the BasicResponseBase implementation for Thing.

func (Thing) AsTrendingVideos Uses

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

AsTrendingVideos is the BasicResponseBase implementation for Thing.

func (Thing) AsVideoDetails Uses

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

AsVideoDetails is the BasicResponseBase implementation for Thing.

func (Thing) AsVideoObject Uses

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

AsVideoObject is the BasicResponseBase implementation for Thing.

func (Thing) AsVideos Uses

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

AsVideos is the BasicResponseBase implementation for Thing.

func (Thing) MarshalJSON Uses

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

MarshalJSON is the custom marshaler for Thing.

type TrendingVideos Uses

type TrendingVideos struct {
    autorest.Response `json:"-"`
    BannerTiles       *[]TrendingVideosTile     `json:"bannerTiles,omitempty"`
    Categories        *[]TrendingVideosCategory `json:"categories,omitempty"`
    // WebSearchURL - READ-ONLY; The URL To Bing's search result for this item.
    WebSearchURL *string `json:"webSearchUrl,omitempty"`
    // ID - READ-ONLY; 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 Uses

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

AsAnswer is the BasicResponseBase implementation for TrendingVideos.

func (TrendingVideos) AsBasicAnswer Uses

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

AsBasicAnswer is the BasicResponseBase implementation for TrendingVideos.

func (TrendingVideos) AsBasicCreativeWork Uses

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

AsBasicCreativeWork is the BasicResponseBase implementation for TrendingVideos.

func (TrendingVideos) AsBasicIdentifiable Uses

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

AsBasicIdentifiable is the BasicResponseBase implementation for TrendingVideos.

func (TrendingVideos) AsBasicMediaObject Uses

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

AsBasicMediaObject is the BasicResponseBase implementation for TrendingVideos.

func (TrendingVideos) AsBasicResponse Uses

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

AsBasicResponse is the BasicResponseBase implementation for TrendingVideos.

func (TrendingVideos) AsBasicResponseBase Uses

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

AsBasicResponseBase is the BasicResponseBase implementation for TrendingVideos.

func (TrendingVideos) AsBasicSearchResultsAnswer Uses

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

AsBasicSearchResultsAnswer is the BasicResponseBase implementation for TrendingVideos.

func (TrendingVideos) AsBasicThing Uses

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

AsBasicThing is the BasicResponseBase implementation for TrendingVideos.

func (TrendingVideos) AsCreativeWork Uses

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

AsCreativeWork is the BasicResponseBase implementation for TrendingVideos.

func (TrendingVideos) AsErrorResponse Uses

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

AsErrorResponse is the BasicResponseBase implementation for TrendingVideos.

func (TrendingVideos) AsIdentifiable Uses

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

AsIdentifiable is the BasicResponseBase implementation for TrendingVideos.

func (TrendingVideos) AsImageObject Uses

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

AsImageObject is the BasicResponseBase implementation for TrendingVideos.

func (TrendingVideos) AsMediaObject Uses

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

AsMediaObject is the BasicResponseBase implementation for TrendingVideos.

func (TrendingVideos) AsResponse Uses

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

AsResponse is the BasicResponseBase implementation for TrendingVideos.

func (TrendingVideos) AsResponseBase Uses

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

AsResponseBase is the BasicResponseBase implementation for TrendingVideos.

func (TrendingVideos) AsSearchResultsAnswer Uses

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

AsSearchResultsAnswer is the BasicResponseBase implementation for TrendingVideos.

func (TrendingVideos) AsThing Uses

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

AsThing is the BasicResponseBase implementation for TrendingVideos.

func (TrendingVideos) AsTrendingVideos Uses

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

AsTrendingVideos is the BasicResponseBase implementation for TrendingVideos.

func (TrendingVideos) AsVideoDetails Uses

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

AsVideoDetails is the BasicResponseBase implementation for TrendingVideos.

func (TrendingVideos) AsVideoObject Uses

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

AsVideoObject is the BasicResponseBase implementation for TrendingVideos.

func (TrendingVideos) AsVideos Uses

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

AsVideos is the BasicResponseBase implementation for TrendingVideos.

func (TrendingVideos) MarshalJSON Uses

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

MarshalJSON is the custom marshaler for TrendingVideos.

type TrendingVideosCategory Uses

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

TrendingVideosCategory ...

type TrendingVideosSubcategory Uses

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

TrendingVideosSubcategory ...

type TrendingVideosTile Uses

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

TrendingVideosTile ...

type Type Uses

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 Uses

func PossibleTypeValues() []Type

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

type VideoDetails Uses

type VideoDetails struct {
    autorest.Response `json:"-"`
    // RelatedVideos - READ-ONLY
    RelatedVideos *VideosModule `json:"relatedVideos,omitempty"`
    // VideoResult - READ-ONLY
    VideoResult *VideoObject `json:"videoResult,omitempty"`
    // WebSearchURL - READ-ONLY; The URL To Bing's search result for this item.
    WebSearchURL *string `json:"webSearchUrl,omitempty"`
    // ID - READ-ONLY; 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 Uses

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

AsAnswer is the BasicResponseBase implementation for VideoDetails.

func (VideoDetails) AsBasicAnswer Uses

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

AsBasicAnswer is the BasicResponseBase implementation for VideoDetails.

func (VideoDetails) AsBasicCreativeWork Uses

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

AsBasicCreativeWork is the BasicResponseBase implementation for VideoDetails.

func (VideoDetails) AsBasicIdentifiable Uses

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

AsBasicIdentifiable is the BasicResponseBase implementation for VideoDetails.

func (VideoDetails) AsBasicMediaObject Uses

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

AsBasicMediaObject is the BasicResponseBase implementation for VideoDetails.

func (VideoDetails) AsBasicResponse Uses

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

AsBasicResponse is the BasicResponseBase implementation for VideoDetails.

func (VideoDetails) AsBasicResponseBase Uses

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

AsBasicResponseBase is the BasicResponseBase implementation for VideoDetails.

func (VideoDetails) AsBasicSearchResultsAnswer Uses

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

AsBasicSearchResultsAnswer is the BasicResponseBase implementation for VideoDetails.

func (VideoDetails) AsBasicThing Uses

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

AsBasicThing is the BasicResponseBase implementation for VideoDetails.

func (VideoDetails) AsCreativeWork Uses

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

AsCreativeWork is the BasicResponseBase implementation for VideoDetails.

func (VideoDetails) AsErrorResponse Uses

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

AsErrorResponse is the BasicResponseBase implementation for VideoDetails.

func (VideoDetails) AsIdentifiable Uses

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

AsIdentifiable is the BasicResponseBase implementation for VideoDetails.

func (VideoDetails) AsImageObject Uses

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

AsImageObject is the BasicResponseBase implementation for VideoDetails.

func (VideoDetails) AsMediaObject Uses

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

AsMediaObject is the BasicResponseBase implementation for VideoDetails.

func (VideoDetails) AsResponse Uses

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

AsResponse is the BasicResponseBase implementation for VideoDetails.

func (VideoDetails) AsResponseBase Uses

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

AsResponseBase is the BasicResponseBase implementation for VideoDetails.

func (VideoDetails) AsSearchResultsAnswer Uses

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

AsSearchResultsAnswer is the BasicResponseBase implementation for VideoDetails.

func (VideoDetails) AsThing Uses

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

AsThing is the BasicResponseBase implementation for VideoDetails.

func (VideoDetails) AsTrendingVideos Uses

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

AsTrendingVideos is the BasicResponseBase implementation for VideoDetails.

func (VideoDetails) AsVideoDetails Uses

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

AsVideoDetails is the BasicResponseBase implementation for VideoDetails.

func (VideoDetails) AsVideoObject Uses

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

AsVideoObject is the BasicResponseBase implementation for VideoDetails.

func (VideoDetails) AsVideos Uses

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

AsVideos is the BasicResponseBase implementation for VideoDetails.

func (VideoDetails) MarshalJSON Uses

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

MarshalJSON is the custom marshaler for VideoDetails.

type VideoInsightModule Uses

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 Uses

func PossibleVideoInsightModuleValues() []VideoInsightModule

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

type VideoLength Uses

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 Uses

func PossibleVideoLengthValues() []VideoLength

PossibleVideoLengthValues returns an array of possible values for the VideoLength const type.

type VideoObject Uses

type VideoObject struct {
    // MotionThumbnailURL - READ-ONLY
    MotionThumbnailURL *string `json:"motionThumbnailUrl,omitempty"`
    // MotionThumbnailID - READ-ONLY
    MotionThumbnailID *string `json:"motionThumbnailId,omitempty"`
    // EmbedHTML - READ-ONLY
    EmbedHTML *string `json:"embedHtml,omitempty"`
    // AllowHTTPSEmbed - READ-ONLY
    AllowHTTPSEmbed *bool `json:"allowHttpsEmbed,omitempty"`
    // ViewCount - READ-ONLY
    ViewCount *int32 `json:"viewCount,omitempty"`
    // Thumbnail - READ-ONLY
    Thumbnail *ImageObject `json:"thumbnail,omitempty"`
    // VideoID - READ-ONLY
    VideoID *string `json:"videoId,omitempty"`
    // AllowMobileEmbed - READ-ONLY
    AllowMobileEmbed *bool `json:"allowMobileEmbed,omitempty"`
    // IsSuperfresh - READ-ONLY
    IsSuperfresh *bool `json:"isSuperfresh,omitempty"`
    // ContentURL - READ-ONLY; 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 - READ-ONLY; URL of the page that hosts the media object.
    HostPageURL *string `json:"hostPageUrl,omitempty"`
    // Width - READ-ONLY; The width of the source media object, in pixels.
    Width *int32 `json:"width,omitempty"`
    // Height - READ-ONLY; The height of the source media object, in pixels.
    Height *int32 `json:"height,omitempty"`
    // ThumbnailURL - READ-ONLY; The URL to a thumbnail of the item.
    ThumbnailURL *string `json:"thumbnailUrl,omitempty"`
    // Provider - READ-ONLY; The source of the creative work.
    Provider *[]BasicThing `json:"provider,omitempty"`
    // Text - READ-ONLY
    Text *string `json:"text,omitempty"`
    // Name - READ-ONLY; The name of the thing represented by this object.
    Name *string `json:"name,omitempty"`
    // URL - READ-ONLY; The URL to get more information about the thing represented by this object.
    URL *string `json:"url,omitempty"`
    // Image - READ-ONLY
    Image *ImageObject `json:"image,omitempty"`
    // Description - READ-ONLY; A short description of the item.
    Description *string `json:"description,omitempty"`
    // AlternateName - READ-ONLY
    AlternateName *string `json:"alternateName,omitempty"`
    // BingID - READ-ONLY; An ID that uniquely identifies this item.
    BingID *string `json:"bingId,omitempty"`
    // WebSearchURL - READ-ONLY; The URL To Bing's search result for this item.
    WebSearchURL *string `json:"webSearchUrl,omitempty"`
    // ID - READ-ONLY; 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 Uses

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

AsAnswer is the BasicResponseBase implementation for VideoObject.

func (VideoObject) AsBasicAnswer Uses

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

AsBasicAnswer is the BasicResponseBase implementation for VideoObject.

func (VideoObject) AsBasicCreativeWork Uses

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

AsBasicCreativeWork is the BasicResponseBase implementation for VideoObject.

func (VideoObject) AsBasicIdentifiable Uses

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

AsBasicIdentifiable is the BasicResponseBase implementation for VideoObject.

func (VideoObject) AsBasicMediaObject Uses

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

AsBasicMediaObject is the BasicResponseBase implementation for VideoObject.

func (VideoObject) AsBasicResponse Uses

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

AsBasicResponse is the BasicResponseBase implementation for VideoObject.

func (VideoObject) AsBasicResponseBase Uses

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

AsBasicResponseBase is the BasicResponseBase implementation for VideoObject.

func (VideoObject) AsBasicSearchResultsAnswer Uses

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

AsBasicSearchResultsAnswer is the BasicResponseBase implementation for VideoObject.

func (VideoObject) AsBasicThing Uses

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

AsBasicThing is the BasicResponseBase implementation for VideoObject.

func (VideoObject) AsCreativeWork Uses

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

AsCreativeWork is the BasicResponseBase implementation for VideoObject.

func (VideoObject) AsErrorResponse Uses

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

AsErrorResponse is the BasicResponseBase implementation for VideoObject.

func (VideoObject) AsIdentifiable Uses

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

AsIdentifiable is the BasicResponseBase implementation for VideoObject.

func (VideoObject) AsImageObject Uses

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

AsImageObject is the BasicResponseBase implementation for VideoObject.

func (VideoObject) AsMediaObject Uses

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

AsMediaObject is the BasicResponseBase implementation for VideoObject.

func (VideoObject) AsResponse Uses

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

AsResponse is the BasicResponseBase implementation for VideoObject.

func (VideoObject) AsResponseBase Uses

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

AsResponseBase is the BasicResponseBase implementation for VideoObject.

func (VideoObject) AsSearchResultsAnswer Uses

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

AsSearchResultsAnswer is the BasicResponseBase implementation for VideoObject.

func (VideoObject) AsThing Uses

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

AsThing is the BasicResponseBase implementation for VideoObject.

func (VideoObject) AsTrendingVideos Uses

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

AsTrendingVideos is the BasicResponseBase implementation for VideoObject.

func (VideoObject) AsVideoDetails Uses

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

AsVideoDetails is the BasicResponseBase implementation for VideoObject.

func (VideoObject) AsVideoObject Uses

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

AsVideoObject is the BasicResponseBase implementation for VideoObject.

func (VideoObject) AsVideos Uses

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

AsVideos is the BasicResponseBase implementation for VideoObject.

func (VideoObject) MarshalJSON Uses

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

MarshalJSON is the custom marshaler for VideoObject.

func (*VideoObject) UnmarshalJSON Uses

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

UnmarshalJSON is the custom unmarshaler for VideoObject struct.

type VideoPricing Uses

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 Uses

func PossibleVideoPricingValues() []VideoPricing

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

type VideoQueryScenario Uses

type VideoQueryScenario string

VideoQueryScenario enumerates the values for video query scenario.

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

func PossibleVideoQueryScenarioValues Uses

func PossibleVideoQueryScenarioValues() []VideoQueryScenario

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

type VideoResolution Uses

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 Uses

func PossibleVideoResolutionValues() []VideoResolution

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

type Videos Uses

type Videos struct {
    autorest.Response `json:"-"`
    // Value - A list of video objects that are relevant to the query.
    Value *[]VideoObject `json:"value,omitempty"`
    // NextOffset - READ-ONLY
    NextOffset *int32 `json:"nextOffset,omitempty"`
    // Scenario - READ-ONLY; Possible values include: 'List', 'SingleDominantVideo'
    Scenario VideoQueryScenario `json:"scenario,omitempty"`
    // QueryExpansions - READ-ONLY
    QueryExpansions *[]Query `json:"queryExpansions,omitempty"`
    // PivotSuggestions - READ-ONLY
    PivotSuggestions *[]PivotSuggestions `json:"pivotSuggestions,omitempty"`
    // TotalEstimatedMatches - READ-ONLY; 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 - READ-ONLY
    IsFamilyFriendly *bool `json:"isFamilyFriendly,omitempty"`
    // FollowUpQueries - READ-ONLY
    FollowUpQueries *[]Query `json:"followUpQueries,omitempty"`
    // WebSearchURL - READ-ONLY; The URL To Bing's search result for this item.
    WebSearchURL *string `json:"webSearchUrl,omitempty"`
    // ID - READ-ONLY; 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 Uses

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

AsAnswer is the BasicResponseBase implementation for Videos.

func (Videos) AsBasicAnswer Uses

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

AsBasicAnswer is the BasicResponseBase implementation for Videos.

func (Videos) AsBasicCreativeWork Uses

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

AsBasicCreativeWork is the BasicResponseBase implementation for Videos.

func (Videos) AsBasicIdentifiable Uses

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

AsBasicIdentifiable is the BasicResponseBase implementation for Videos.

func (Videos) AsBasicMediaObject Uses

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

AsBasicMediaObject is the BasicResponseBase implementation for Videos.

func (Videos) AsBasicResponse Uses

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

AsBasicResponse is the BasicResponseBase implementation for Videos.

func (Videos) AsBasicResponseBase Uses

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

AsBasicResponseBase is the BasicResponseBase implementation for Videos.

func (Videos) AsBasicSearchResultsAnswer Uses

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

AsBasicSearchResultsAnswer is the BasicResponseBase implementation for Videos.

func (Videos) AsBasicThing Uses

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

AsBasicThing is the BasicResponseBase implementation for Videos.

func (Videos) AsCreativeWork Uses

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

AsCreativeWork is the BasicResponseBase implementation for Videos.

func (Videos) AsErrorResponse Uses

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

AsErrorResponse is the BasicResponseBase implementation for Videos.

func (Videos) AsIdentifiable Uses

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

AsIdentifiable is the BasicResponseBase implementation for Videos.

func (Videos) AsImageObject Uses

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

AsImageObject is the BasicResponseBase implementation for Videos.

func (Videos) AsMediaObject Uses

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

AsMediaObject is the BasicResponseBase implementation for Videos.

func (Videos) AsResponse Uses

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

AsResponse is the BasicResponseBase implementation for Videos.

func (Videos) AsResponseBase Uses

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

AsResponseBase is the BasicResponseBase implementation for Videos.

func (Videos) AsSearchResultsAnswer Uses

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

AsSearchResultsAnswer is the BasicResponseBase implementation for Videos.

func (Videos) AsThing Uses

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

AsThing is the BasicResponseBase implementation for Videos.

func (Videos) AsTrendingVideos Uses

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

AsTrendingVideos is the BasicResponseBase implementation for Videos.

func (Videos) AsVideoDetails Uses

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

AsVideoDetails is the BasicResponseBase implementation for Videos.

func (Videos) AsVideoObject Uses

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

AsVideoObject is the BasicResponseBase implementation for Videos.

func (Videos) AsVideos Uses

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

AsVideos is the BasicResponseBase implementation for Videos.

func (Videos) MarshalJSON Uses

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

MarshalJSON is the custom marshaler for Videos.

type VideosClient Uses

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 Uses

func NewVideosClient() VideosClient

NewVideosClient creates an instance of the VideosClient client.

func (VideosClient) Details Uses

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 Uses

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 Uses

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 Uses

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 Uses

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 Uses

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 Uses

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 Uses

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 Uses

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 Uses

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 Uses

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 Uses

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 Uses

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

VideosModule ...

Directories

PathSynopsis
videosearchapi

Package videosearch imports 7 packages (graph) and is imported by 3 packages. Updated 2019-07-30. Refresh now. Tools for package owners.