Documentation ¶
Index ¶
- Variables
- func BuildRequestURL(urlStr string) string
- type AuthEndpoints
- type Client
- func (c *Client) AddCreditToVideo(video string, params *Parameters) (*CreditsDataElement, error)
- func (c *Client) AddPictureToVideo(video string, params *Parameters) (*VideoDataElement, error)
- func (c *Client) AddVideoCategories(video string, params *Parameters) error
- func (c *Client) AddVideoUser(video, user string, params *Parameters) error
- func (c *Client) AddVideoUsers(video string, params *Parameters) (*UserData, error)
- func (c *Client) AddWatchLater(video string, params *Parameters) error
- func (c *Client) ApplyDefaults(req *http.Request)
- func (c *Client) ChangeMe(params *Parameters) (*User, error)
- func (c *Client) ChangeMyAlbum(album string, params *Parameters) (*AlbumDataElement, error)
- func (c *Client) ChangeUser(user string, params *Parameters) (*User, error)
- func (c *Client) ChangeUserAlbum(user string, album string, params *Parameters) (*AlbumDataElement, error)
- func (c *Client) ChangeVideo(video string, params *Parameters) (*VideoDataElement, error)
- func (c *Client) ChangeVideoComment(video, comment string, params *Parameters) (*CommentDataElement, error)
- func (c *Client) ChangeVideoCredit(video, credit string, params *Parameters) (*Picture, error)
- func (c *Client) ChangeVideoPicture(video, picture string, params *Parameters) (*Picture, error)
- func (c *Client) CheckIfVideoInCategory(category, video string, params *Parameters) (*VideoDataElement, error)
- func (c *Client) CheckIfVideoInChannel(channel, video string, params *Parameters) (*VideoDataElement, error)
- func (c *Client) CheckIfVideoInGroup(group, video string, params *Parameters) (*VideoDataElement, error)
- func (c *Client) CheckIfVideoInMyAlbum(album, video string, params *Parameters) (*VideoDataElement, error)
- func (c *Client) CheckIfVideoInUserAlbum(user, album, video string, params *Parameters) (*VideoDataElement, error)
- func (c *Client) CheckVideoInMyWatchedlater(video string, params *Parameters) (bool, error)
- func (c *Client) CheckVideoInUserWatchedlater(user, video string, params *Parameters) (bool, error)
- func (c *Client) CheckVideoTag(video, tag string, params *Parameters) (*TagsData, error)
- func (c *Client) CommentVideo(video string, params *Parameters) (*CommentDataElement, error)
- func (c *Client) CreateChannel(params *Parameters) (map[string]interface{}, error)
- func (c *Client) CreateGroup(params *Parameters) (*GroupDataElement, error)
- func (c *Client) Delete(urlStr string) (*http.Response, error)
- func (c *Client) DeleteChannel(channel string, params *Parameters) (*ChannelDataElement, error)
- func (c *Client) DeleteGroup(group string, params *Parameters) error
- func (c *Client) DeleteMyAlbum(album string, params *Parameters) error
- func (c *Client) DeleteMyPicture(picture string, params *Parameters) error
- func (c *Client) DeleteMyWatchedVideo(video string, params *Parameters) error
- func (c *Client) DeleteMyWatchedVideos(params *Parameters) error
- func (c *Client) DeleteMyWatchlaterVideo(video string, params *Parameters) error
- func (c *Client) DeleteUserAlbum(user, album string, params *Parameters) error
- func (c *Client) DeleteUserPicture(user, picture string, params *Parameters) error
- func (c *Client) DeleteUserWatchedVideo(user, video string, params *Parameters) error
- func (c *Client) DeleteUserWatchedVideos(user string, params *Parameters) error
- func (c *Client) DeleteUserWatchlaterVideo(user, video string, params *Parameters) error
- func (c *Client) DeleteVideo(video string, params *Parameters) error
- func (c *Client) DeleteVideoComment(video, comment string, params *Parameters) error
- func (c *Client) DeleteVideoCredit(video, credit string, params *Parameters) error
- func (c *Client) DeleteVideoFromChannel(channel, video string, params *Parameters) error
- func (c *Client) DeleteVideoFromGroup(group, video string, params *Parameters) error
- func (c *Client) DeleteVideoFromMyAlbum(album, video string, params *Parameters) error
- func (c *Client) DeleteVideoFromUserAlbum(user, album, video string, params *Parameters) error
- func (c *Client) DeleteVideoPicture(video, picture string, params *Parameters) error
- func (c *Client) DeleteVideoTag(video, tag string, params *Parameters) error
- func (c *Client) DeleteVideoUser(video, user string, params *Parameters) error
- func (c *Client) GenerateAuthAccessToken(redirectURI, scope, state string) error
- func (c *Client) GenerateUnauthAccessToken(scope string) error
- func (c *Client) Get(urlStr string, params *Parameters) (*http.Response, error)
- func (c *Client) GetCategories(params *Parameters) (*CategoryData, error)
- func (c *Client) GetCategory(category string, params *Parameters) (*CategoryDataElement, error)
- func (c *Client) GetCategoryChannels(category string, params *Parameters) (*ChannelData, error)
- func (c *Client) GetCategoryGroups(group string, params *Parameters) (*GroupData, error)
- func (c *Client) GetCategoryVideos(category string, params *Parameters) (*VideoData, error)
- func (c *Client) GetChannel(channel string, params *Parameters) (*ChannelDataElement, error)
- func (c *Client) GetChannelUsers(channel string, params *Parameters) (map[string]interface{}, error)
- func (c *Client) GetChannelVideos(channel string, params *Parameters) (*VideoData, error)
- func (c *Client) GetChannels(params *Parameters) (*ChannelData, error)
- func (c *Client) GetContentRatings(params *Parameters) (*CommonsData, error)
- func (c *Client) GetCreativeCommons(params *Parameters) (*CommonsData, error)
- func (c *Client) GetGroup(group string, params *Parameters) (*GroupData, error)
- func (c *Client) GetGroupUsers(group string, params *Parameters) (*UserData, error)
- func (c *Client) GetGroupVideos(group string, params *Parameters) (*VideoData, error)
- func (c *Client) GetGroups(params *Parameters) (*GroupData, error)
- func (c *Client) GetLanguages(params *Parameters) (*CommonsData, error)
- func (c *Client) GetMe(params *Parameters) (*User, error)
- func (c *Client) GetMyAlbum(album string, params *Parameters) (*AlbumDataElement, error)
- func (c *Client) GetMyAlbumVideos(album string, params *Parameters) (*VideoData, error)
- func (c *Client) GetMyAlbums(params *Parameters) (*AlbumData, error)
- func (c *Client) GetMyAppearances(params *Parameters) (*VideoData, error)
- func (c *Client) GetMyChannels(params *Parameters) (*ChannelData, error)
- func (c *Client) GetMyFeed(params *Parameters) (*FeedData, error)
- func (c *Client) GetMyFollowers(params *Parameters) (*FollowersData, error)
- func (c *Client) GetMyFollowing(params *Parameters) (*FollowersData, error)
- func (c *Client) GetMyGroups(params *Parameters) (*GroupData, error)
- func (c *Client) GetMyLikes(params *Parameters) (*LikesData, error)
- func (c *Client) GetMyPictures(params *Parameters) (*PicturesData, error)
- func (c *Client) GetMyPorfolios(params *Parameters) (*PortfolioData, error)
- func (c *Client) GetMyPortfolio(portfolio string, params *Parameters) (*Portfolio, error)
- func (c *Client) GetMyPortfolioVideos(portfolio string, params *Parameters) (*VideoData, error)
- func (c *Client) GetMyVideo(video string, params *Parameters) (*VideoDataElement, error)
- func (c *Client) GetMyVideos(params *Parameters) (*VideoData, error)
- func (c *Client) GetMyWatchedVideos(params *Parameters) (*VideoData, error)
- func (c *Client) GetRelatedVideos(video string, params *Parameters) (*VideoData, error)
- func (c *Client) GetTag(tag string, params *Parameters) (*Tag, error)
- func (c *Client) GetTagVideos(tag string, params *Parameters) (*VideoData, error)
- func (c *Client) GetToken(code, redirectURI string) error
- func (c *Client) GetUser(user string, params *Parameters) (*User, error)
- func (c *Client) GetUserAlbum(user string, album string, params *Parameters) (*AlbumDataElement, error)
- func (c *Client) GetUserAlbumVideos(user, album string, params *Parameters) (*VideoData, error)
- func (c *Client) GetUserAlbums(user string, params *Parameters) (*AlbumData, error)
- func (c *Client) GetUserAppearances(user string, params *Parameters) (*VideoData, error)
- func (c *Client) GetUserChannels(user string, params *Parameters) (*ChannelData, error)
- func (c *Client) GetUserFeed(user string, params *Parameters) (*FeedData, error)
- func (c *Client) GetUserFollowers(user string, params *Parameters) (*FollowersData, error)
- func (c *Client) GetUserFollowing(user string, params *Parameters) (*FollowersData, error)
- func (c *Client) GetUserLikes(user string, params *Parameters) (*LikesData, error)
- func (c *Client) GetUserPictures(user string, params *Parameters) (*PicturesData, error)
- func (c *Client) GetUserPorfolios(user string, params *Parameters) (*PortfolioData, error)
- func (c *Client) GetUserPortfolio(user, portfolio string, params *Parameters) (*Portfolio, error)
- func (c *Client) GetUserPortfolioVideos(user, portfolio string, params *Parameters) (*VideoData, error)
- func (c *Client) GetUserVideo(user, video string, params *Parameters) (*VideoDataElement, error)
- func (c *Client) GetUserVideos(user, params *Parameters) (*VideoData, error)
- func (c *Client) GetUserWatchLater(user string, params *Parameters) (*VideoDataElement, error)
- func (c *Client) GetUserWatchedVideos(user string, params *Parameters) (*VideoData, error)
- func (c *Client) GetUsers(params *Parameters) (*UserData, error)
- func (c *Client) GetVideo(video string, params *Parameters) (*VideoDataElement, error)
- func (c *Client) GetVideoCategories(video string, params *Parameters) (*CategoryData, error)
- func (c *Client) GetVideoCommentReplies(video, comment string, params *Parameters) (*CommentData, error)
- func (c *Client) GetVideoComments(video string, params *Parameters) (*CommentData, error)
- func (c *Client) GetVideoCredit(video, credit string, params *Parameters) (*CreditsDataElement, error)
- func (c *Client) GetVideoCredits(video string, params *Parameters) (*CreditsData, error)
- func (c *Client) GetVideoLikes(video string, params *Parameters) (*LikesData, error)
- func (c *Client) GetVideoPicture(video, picture string, params *Parameters) (*Picture, error)
- func (c *Client) GetVideoPictures(video string, params *Parameters) (*PicturesData, error)
- func (c *Client) GetVideoTags(video string, params *Parameters) (*TagsData, error)
- func (c *Client) GetVideoUsers(video string, params *Parameters) (*UserData, error)
- func (c *Client) GetVideos(params *Parameters) (*VideoData, error)
- func (c *Client) GetWatchLater(params *Parameters) (*VideoDataElement, error)
- func (c *Client) ListAll() (*Endpoints, error)
- func (c *Client) MeEditPicture(picture string, params *Parameters) (*Picture, error)
- func (c *Client) MeFollowCategory(category string, params *Parameters) error
- func (c *Client) MeFollowChannel(channel string, params *Parameters) error
- func (c *Client) MeFollowGroup(group string, params *Parameters) error
- func (c *Client) MeFollowUser(user string, params *Parameters) error
- func (c *Client) MeFollowingCategory(category string, params *Parameters) (bool, error)
- func (c *Client) MeFollowingChannel(channel string, params *Parameters) (bool, error)
- func (c *Client) MeFollowingGroup(group string, params *Parameters) (bool, error)
- func (c *Client) MeFollowingUser(user string, params *Parameters) (bool, error)
- func (c *Client) MeHasPicture(picture string, params *Parameters) (*Picture, error)
- func (c *Client) MeLikeVideo(video string, params *Parameters) error
- func (c *Client) MeLikingVideo(video string, params *Parameters) (bool, error)
- func (c *Client) MeUnfollowCategory(category string, params *Parameters) error
- func (c *Client) MeUnfollowChannel(channel string, params *Parameters) error
- func (c *Client) MeUnfollowGroup(group string, params *Parameters) error
- func (c *Client) MeUnfollowUser(user string, params *Parameters) error
- func (c *Client) MeUnlikeVideo(video string, params *Parameters) error
- func (c *Client) MeUploadVideo(params *Parameters) (*Upload, error)
- func (c *Client) MyPortfoliosAddVideo(portfolio, video string, params *Parameters) error
- func (c *Client) MyPortfoliosContaintsVideo(portfolio, video string, params *Parameters) (bool, error)
- func (c *Client) MyPortfoliosDeleteVideos(portfolio, video string, params *Parameters) error
- func (c *Client) Patch(urlStr string, params *Parameters) (*http.Response, error)
- func (c *Client) PatchChannel(channel string, params *Parameters) (*ChannelDataElement, error)
- func (c *Client) Post(urlStr string, params *Parameters) (*http.Response, error)
- func (c *Client) Put(urlStr string) (*http.Response, error)
- func (c *Client) PutInMyAlbums(params *Parameters) (*AlbumDataElement, error)
- func (c *Client) PutInUserAlbums(user string, params *Parameters) (*AlbumDataElement, error)
- func (c *Client) PutVideoInChannel(channel, video string, params *Parameters) error
- func (c *Client) PutVideoInGroup(group, video string, params *Parameters) error
- func (c *Client) PutVideoInMyAlbum(album, video string, params *Parameters) error
- func (c *Client) PutVideoInUserAlbum(user, album, video string, params *Parameters) error
- func (c *Client) ReplaceVideo(video string, params *Parameters) error
- func (c *Client) ReplyToCommentVideo(video, comment string, params *Parameters) (*CommentDataElement, error)
- func (c *Client) Upload(filePath string) (*http.Response, error)
- func (c *Client) UploadPicture(params *Parameters) (*Picture, error)
- func (c *Client) UserAddWatchLater(user, video string, params *Parameters) error
- func (c *Client) UserEditPicture(user, picture string, params *Parameters) (*Picture, error)
- func (c *Client) UserFollowCategory(user, category string, params *Parameters) error
- func (c *Client) UserFollowChannel(user, channel string, params *Parameters) error
- func (c *Client) UserFollowGroup(user, group string, params *Parameters) error
- func (c *Client) UserFollowUser(user, followed string, params *Parameters) error
- func (c *Client) UserFollowingCategory(user, category string, params *Parameters) (bool, error)
- func (c *Client) UserFollowingChannel(user, channel string, params *Parameters) (bool, error)
- func (c *Client) UserFollowingGroup(user, group string, params *Parameters) (bool, error)
- func (c *Client) UserFollowingUser(user, followed string, params *Parameters) (bool, error)
- func (c *Client) UserHasPicture(user, picture string, params *Parameters) (*Picture, error)
- func (c *Client) UserLikeVideo(user, video string, params *Parameters) error
- func (c *Client) UserLikingVideo(user, video string, params *Parameters) (bool, error)
- func (c *Client) UserMyGroups(user string, params *Parameters) (*GroupData, error)
- func (c *Client) UserPortfoliosAddVideo(user, portfolio, video string, params *Parameters) error
- func (c *Client) UserPortfoliosContaintsVideo(user, portfolio, video string, params *Parameters) (bool, error)
- func (c *Client) UserPortfoliosDeleteVideos(user, portfolio, video string, params *Parameters) error
- func (c *Client) UserUnfollowCategory(user, category string, params *Parameters) error
- func (c *Client) UserUnfollowChannel(user, channel string, params *Parameters) error
- func (c *Client) UserUnfollowGroup(user, group string, params *Parameters) error
- func (c *Client) UserUnfollowUser(user, followed string, params *Parameters) error
- func (c *Client) UserUnlikeVideo(user, video string, params *Parameters) error
- func (c *Client) UserUploadPicture(user string, params *Parameters) (*Picture, error)
- func (c *Client) UserUploadVideo(user string, params *Parameters) (*AlbumDataElement, error)
- func (c *Client) Verify(completeURI string) (*http.Response, error)
- func (c *Client) VerifyToken(params *Parameters) (*Oauth, error)
- func (c *Client) VideoPutTag(video, tag string, params *Parameters) error
- type Headers
- type Parameters
- type Request
Constants ¶
This section is empty.
Variables ¶
var AuthenticationEndpoints = &AuthEndpoints{
"/oauth/authorize",
"/oauth/access_token",
"/oauth/authorize/client",
}
AuthenticationEndpoints contains the default auth endpoints
var DefaultRequest = &Request{ Hostname: "https://api.vimeo.com", Headers: &Headers{ "Content-Type": "application/x-www-form-urlencoded", "Accept": "application/vnd.vimeo.*+json;version=3.2", }, }
DefaultRequest contains the default values, used by all requests
Functions ¶
func BuildRequestURL ¶
BuildRequestURL builds a request URL from host and path
Types ¶
type AuthEndpoints ¶
type AuthEndpoints struct {
// contains filtered or unexported fields
}
AuthEndpoints are the main authorization endpoints
type Client ¶
type Client struct {
// contains filtered or unexported fields
}
Client is the type of object that identifies the user.
func (*Client) AddCreditToVideo ¶
func (c *Client) AddCreditToVideo(video string, params *Parameters) (*CreditsDataElement, error)
AddCreditToVideo adds a credit to a video. Name Type Required Description role string Yes The role of the person being credited name string Yes The name of the person being credited email string Yes The email address of the person being credited user_uri string Yes The URI of the Vimeo user who should be given credit in this video
func (*Client) AddPictureToVideo ¶
func (c *Client) AddPictureToVideo(video string, params *Parameters) (*VideoDataElement, error)
AddPictureToVideo adds a picture resource to a video This method requires a token with the "upload" scope.
func (*Client) AddVideoCategories ¶
func (c *Client) AddVideoCategories(video string, params *Parameters) error
AddVideoCategories adds up to 2 categories and 1 sub-category to a video. This is mearly a suggestion, and does not ensure that the video will added to the category. This method requires a token with the "edit" scope.
func (*Client) AddVideoUser ¶
func (c *Client) AddVideoUser(video, user string, params *Parameters) error
AddVideoUser adds a user to the allowed users list. This method requires a token with the "edit" scope.
func (*Client) AddVideoUsers ¶
func (c *Client) AddVideoUsers(video string, params *Parameters) (*UserData, error)
AddVideoUsers adds users to the allowed users list. This method requires a token with the "edit" scope.
func (*Client) AddWatchLater ¶
func (c *Client) AddWatchLater(video string, params *Parameters) error
AddWatchLater adds a video to the authenticated user's watch later list. This method requires a token with the "interact" scope.
func (*Client) ApplyDefaults ¶
ApplyDefaults applies the default values from DefaultRequest to our request
func (*Client) ChangeMe ¶
func (c *Client) ChangeMe(params *Parameters) (*User, error)
ChangeMe edits my users Name Type Required Description videos.privacy.download boolean No Sets the default download setting for all future videos uploaded by this user. If true, the video can be downloaded by any user. videos.privacy.add boolean No Sets the default add setting for all future videos uploaded by this user. If true, anyone can add the video to an album, channel, or group. videos.privacy.comments string No Sets the default comment setting for all future videos uploaded by this user. It specifies who can comment on the video.
anybody nobody contacts
videos.privacy.view string No Sets the default view setting for all future videos uploaded by this user. It specifies who can view the video.
anybody nobody contacts password users unlisted disable
videos.privacy.embed string No Sets the default embed setting for all future videos uploaded by this user. Whitelist allows you to define all valid embed domains. Check out our docs for adding and removing domains.
public private whitelistname
name string No The user's display name location string No The user's location bio string No The user's bio
func (*Client) ChangeMyAlbum ¶
func (c *Client) ChangeMyAlbum(album string, params *Parameters) (*AlbumDataElement, error)
ChangeMyAlbum edits an album This method requires a token with the "create" scope. Name Type Required Description name string Yes The Album title description string Yes The Album description privacy string No The Album's privacy level
anybody password
sort string No The default sort order of an Album's videos
arranged newest oldest plays comments likes added_first added_last alphabetical
func (*Client) ChangeUser ¶
func (c *Client) ChangeUser(user string, params *Parameters) (*User, error)
ChangeUser edits an user Name Type Required Description videos.privacy.download boolean No Sets the default download setting for all future videos uploaded by this user. If true, the video can be downloaded by any user. videos.privacy.add boolean No Sets the default add setting for all future videos uploaded by this user. If true, anyone can add the video to an album, channel, or group. videos.privacy.comments string No Sets the default comment setting for all future videos uploaded by this user. It specifies who can comment on the video.
anybody nobody contacts
videos.privacy.view string No Sets the default view setting for all future videos uploaded by this user. It specifies who can view the video.
anybody nobody contacts password users unlisted disable
videos.privacy.embed string No Sets the default embed setting for all future videos uploaded by this user. Whitelist allows you to define all valid embed domains. Check out our docs for adding and removing domains.
public private whitelistname
name string No The user's display name location string No The user's location bio string No The user's bio
func (*Client) ChangeUserAlbum ¶
func (c *Client) ChangeUserAlbum(user string, album string, params *Parameters) (*AlbumDataElement, error)
ChangeUserAlbum edits an album This method requires a token with the "create" scope. Name Type Required Description name string Yes The Album title description string Yes The Album description privacy string No The Album's privacy level
anybody password
sort string No The default sort order of an Album's videos
arranged newest oldest plays comments likes added_first added_last alphabetical
func (*Client) ChangeVideo ¶
func (c *Client) ChangeVideo(video string, params *Parameters) (*VideoDataElement, error)
ChangeVideo edits video metadata. This method requires a token with the "edit" scope. Name Type Required Description name string No The new title for the video description string No The new description for the video license string No Set the Creative Commons license
by by-sa by-nd by-nc by-nc-sa by-nc-nd cc0
privacy.view string No The new privacy setting for the video. Content-type application/json is the only valid type for type "users", basic users can not set privacy to unlisted.
anybody nobody contacts password users unlisted disable
privacy.download boolean No Enable or disable the ability for anyone to download video. privacy.add boolean No Enable or disable the ability for anyone to add the video to an album, channel, or group. privacy.comments string No The privacy for who can comment on the video.
anybody nobody contacts
password string No When you set privacy.view to password, you must provide the password as an additional parameter privacy.embed string No The videos new embed settings. Whitelist allows you to define all valid embed domains. Check out our docs for adding and removing domains.
public private whitelist
review_link boolean No Enable or disable the review page locale string No Set the default language for this video. For a full list of valid languages use the "/languages?filter=texttracks" endpoint content_rating array No A list of values describing the content in this video. You can find the full list in the /contentrating endpoint. You must provide a list representation appropriate for your request body (comma separated for querystring, or array for JSON) embed.buttons.like boolean No Show or hide the like button embed.buttons.watchlater boolean No Show or hide the watch later button embed.buttons.share boolean No Show or hide the share button embed.buttons.embed boolean No Show or hide the embed button embed.buttons.hd boolean No Show or hide the hd button embed.buttons.fullscreen boolean No Show or hide the fullscreen button embed.buttons.scaling boolean No Show or hide the scaling button (shown only in fullscreen mode) embed.logos.vimeo boolean No Show or hide the vimeo logo embed.logos.custom.active boolean No Show or hide your custom logo embed.logos.custom.stick boolean No Always show the custom logo, or hide it after time with the rest of the UI embed.logos.custom.lin string No A url that your user will navigate to if they click your custom logo embed.playbar boolean No Show or hide the playbar embed.volume boolean No Show or hide the volume selector embed.color string No A primary color used by the embed player embed.title.owner string No Show, hide, or let the user decide if the owners information shows on the video
user show hide
embed.title.portrait string No Show, hide, or let the user decide if the owners portrait shows on the video
user show hide
embed.title.name string No Show, hide, or let the user decide if the video title shows on the video
user show hide
func (*Client) ChangeVideoComment ¶
func (c *Client) ChangeVideoComment(video, comment string, params *Parameters) (*CommentDataElement, error)
ChangeVideoComment edits an existing comment on a video
func (*Client) ChangeVideoCredit ¶
func (c *Client) ChangeVideoCredit(video, credit string, params *Parameters) (*Picture, error)
ChangeVideoCredit edits information about a single credit This method requires a token with the "edit" scope.
func (*Client) ChangeVideoPicture ¶
func (c *Client) ChangeVideoPicture(video, picture string, params *Parameters) (*Picture, error)
ChangeVideoPicture modifies an existing picture on a video. This method requires a token with the "edit" scope.
func (*Client) CheckIfVideoInCategory ¶
func (c *Client) CheckIfVideoInCategory(category, video string, params *Parameters) (*VideoDataElement, error)
CheckIfVideoInCategory checks if a category contains a video Name Type Required Description page int No The page number to show. per_page int No Number of items to show on each page. Max 50. query string No Search query. sort string No Technique used to sort the results.
date alphabetical videos followers
direction string No The direction that the results are sorted.
asc desc
func (*Client) CheckIfVideoInChannel ¶
func (c *Client) CheckIfVideoInChannel(channel, video string, params *Parameters) (*VideoDataElement, error)
CheckIfVideoInChannel checks if this Channel contains a video.
func (*Client) CheckIfVideoInGroup ¶
func (c *Client) CheckIfVideoInGroup(group, video string, params *Parameters) (*VideoDataElement, error)
CheckIfVideoInGroup checks if a Group has a video.
func (*Client) CheckIfVideoInMyAlbum ¶
func (c *Client) CheckIfVideoInMyAlbum(album, video string, params *Parameters) (*VideoDataElement, error)
CheckIfVideoInMyAlbum cheks if an Album contains a video.
func (*Client) CheckIfVideoInUserAlbum ¶
func (c *Client) CheckIfVideoInUserAlbum(user, album, video string, params *Parameters) (*VideoDataElement, error)
CheckIfVideoInUserAlbum cheks if an Album contains a video.
func (*Client) CheckVideoInMyWatchedlater ¶
func (c *Client) CheckVideoInMyWatchedlater(video string, params *Parameters) (bool, error)
CheckVideoInMyWatchedlater checks if a video is in the authenticated user's Watch Later queue.
func (*Client) CheckVideoInUserWatchedlater ¶
func (c *Client) CheckVideoInUserWatchedlater(user, video string, params *Parameters) (bool, error)
CheckVideoInUserWatchedlater checks if a video is in the authenticated user's Watch Later queue.
func (*Client) CheckVideoTag ¶
func (c *Client) CheckVideoTag(video, tag string, params *Parameters) (*TagsData, error)
CheckVideoTag checks if a tag has been applied to a video
func (*Client) CommentVideo ¶
func (c *Client) CommentVideo(video string, params *Parameters) (*CommentDataElement, error)
CommentVideo posts a comment on the video
func (*Client) CreateChannel ¶
func (c *Client) CreateChannel(params *Parameters) (map[string]interface{}, error)
CreateChannel creates a new Channel. Name Type Required Description name string Yes The name of the new Channel description string Yes The description of the new Channel privacy string Yes The privacy level of the new Channel
anybody user
func (*Client) CreateGroup ¶
func (c *Client) CreateGroup(params *Parameters) (*GroupDataElement, error)
CreateGroup creates a new group This method requires a token with the "create" scope.
func (*Client) Delete ¶
Delete performs a DELETE request to the Vimeo API with urlStr path and params as body.
func (*Client) DeleteChannel ¶
func (c *Client) DeleteChannel(channel string, params *Parameters) (*ChannelDataElement, error)
DeleteChannel deletes a Channel
func (*Client) DeleteGroup ¶
func (c *Client) DeleteGroup(group string, params *Parameters) error
DeleteGroup deletes a GetGroup This method requires a token with the "delete" scope.
func (*Client) DeleteMyAlbum ¶
func (c *Client) DeleteMyAlbum(album string, params *Parameters) error
DeleteMyAlbum deletes an Album.
func (*Client) DeleteMyPicture ¶
func (c *Client) DeleteMyPicture(picture string, params *Parameters) error
DeleteMyPicture removes a portrait from your portrait list. This method requires a token with the "delete" scope.
func (*Client) DeleteMyWatchedVideo ¶
func (c *Client) DeleteMyWatchedVideo(video string, params *Parameters) error
DeleteMyWatchedVideo deletes a watched video
func (*Client) DeleteMyWatchedVideos ¶
func (c *Client) DeleteMyWatchedVideos(params *Parameters) error
DeleteMyWatchedVideos deletes all watched videos
func (*Client) DeleteMyWatchlaterVideo ¶
func (c *Client) DeleteMyWatchlaterVideo(video string, params *Parameters) error
DeleteMyWatchlaterVideo removes a video from your watch later list. This method requires a token with the "interact" scope.
func (*Client) DeleteUserAlbum ¶
func (c *Client) DeleteUserAlbum(user, album string, params *Parameters) error
DeleteUserAlbum deletes an Album.
func (*Client) DeleteUserPicture ¶
func (c *Client) DeleteUserPicture(user, picture string, params *Parameters) error
DeleteUserPicture removes a portrait from your portrait list. This method requires a token with the "delete" scope.
func (*Client) DeleteUserWatchedVideo ¶
func (c *Client) DeleteUserWatchedVideo(user, video string, params *Parameters) error
DeleteUserWatchedVideo deletes all watched videos
func (*Client) DeleteUserWatchedVideos ¶
func (c *Client) DeleteUserWatchedVideos(user string, params *Parameters) error
DeleteUserWatchedVideos gets a list of watched videos
func (*Client) DeleteUserWatchlaterVideo ¶
func (c *Client) DeleteUserWatchlaterVideo(user, video string, params *Parameters) error
DeleteUserWatchlaterVideo removes a video from your watch later list. This method requires a token with the "interact" scope.
func (*Client) DeleteVideo ¶
func (c *Client) DeleteVideo(video string, params *Parameters) error
DeleteVideo deletes a video This method requires a token with the "delete" scope.
func (*Client) DeleteVideoComment ¶
func (c *Client) DeleteVideoComment(video, comment string, params *Parameters) error
DeleteVideoComment deletes a comment from a video This method requires a token with the "delete" scope.
func (*Client) DeleteVideoCredit ¶
func (c *Client) DeleteVideoCredit(video, credit string, params *Parameters) error
DeleteVideoCredit deletes a credit This method requires a token with the "edit" scope.
func (*Client) DeleteVideoFromChannel ¶
func (c *Client) DeleteVideoFromChannel(channel, video string, params *Parameters) error
DeleteVideoFromChannel removes a video from a Channel.
func (*Client) DeleteVideoFromGroup ¶
func (c *Client) DeleteVideoFromGroup(group, video string, params *Parameters) error
DeleteVideoFromGroup removes a video from a Group This method requires a token with the "edit" scope.
func (*Client) DeleteVideoFromMyAlbum ¶
func (c *Client) DeleteVideoFromMyAlbum(album, video string, params *Parameters) error
DeleteVideoFromMyAlbum removes a video from an Album. This method requires a token with the "edit" scope.
func (*Client) DeleteVideoFromUserAlbum ¶
func (c *Client) DeleteVideoFromUserAlbum(user, album, video string, params *Parameters) error
DeleteVideoFromUserAlbum removes a video from an Album. This method requires a token with the "edit" scope.
func (*Client) DeleteVideoPicture ¶
func (c *Client) DeleteVideoPicture(video, picture string, params *Parameters) error
DeleteVideoPicture removes an existing picture from a video. This method requires a token with the "edit" scope.
func (*Client) DeleteVideoTag ¶
func (c *Client) DeleteVideoTag(video, tag string, params *Parameters) error
DeleteVideoTag removes the tag from this video This method requires a token with the "edit" scope.
func (*Client) DeleteVideoUser ¶
func (c *Client) DeleteVideoUser(video, user string, params *Parameters) error
DeleteVideoUser removes a user from the allowed users list. his method requires a token with the "edit" scope.
func (*Client) GenerateAuthAccessToken ¶
GenerateAuthAccessToken is the first step of the redirect process is to send the user's client (browser) to vimeo.com. This is generally accomplished by providing the authorize url as a link on a webpage.
func (*Client) GenerateUnauthAccessToken ¶
GenerateUnauthAccessToken generates an access token it order to make authorized requests. The function takes code and a redirect_uri and returns an access_token.
func (*Client) Get ¶
Get performs a GET request to the Vimeo API with urlStr path and params as body.
func (*Client) GetCategories ¶
func (c *Client) GetCategories(params *Parameters) (*CategoryData, error)
GetCategories gets a list of the top level categories. Possible parameters Name Type Required Description page int No The page number to show. per_page int No Number of items to show on each page. Max 50.
func (*Client) GetCategory ¶
func (c *Client) GetCategory(category string, params *Parameters) (*CategoryDataElement, error)
GetCategory gets a category.
func (*Client) GetCategoryChannels ¶
func (c *Client) GetCategoryChannels(category string, params *Parameters) (*ChannelData, error)
GetCategoryChannels gets a list of Channels related to a category. Name Type Required Description page int No The page number to show. per_page int No Number of items to show on each page. Max 50. query string No Search query. sort string Но No Technique used to sort the results.
date alphabetical videos followers
direction string Но No The direction that the results are sorted.
asc desc
func (*Client) GetCategoryGroups ¶
func (c *Client) GetCategoryGroups(group string, params *Parameters) (*GroupData, error)
GetCategoryGroups get a list of Groups related to a category. Name Type Required Description page int No The page number to show. per_page int No Number of items to show on each page. Max 50. query string No Search query. sort string Но No Technique used to sort the results.
date alphabetical videos followers
direction string Но No The direction that the results are sorted.
asc desc
func (*Client) GetCategoryVideos ¶
func (c *Client) GetCategoryVideos(category string, params *Parameters) (*VideoData, error)
GetCategoryVideos gets a list of videos related to a category. Name Type Required Description page int No The page number to show. per_page int No Number of items to show on each page. Max 50. query string No Search query. sort string No Technique used to sort the results.
date alphabetical videos followers
direction string No The direction that the results are sorted.
asc desc
func (*Client) GetChannel ¶
func (c *Client) GetChannel(channel string, params *Parameters) (*ChannelDataElement, error)
GetChannel gets a Channel.
func (*Client) GetChannelUsers ¶
func (c *Client) GetChannelUsers(channel string, params *Parameters) (map[string]interface{}, error)
GetChannelUsers gets a list of users who follow a Channel. Name Type Required Description page int No The page number to show. per_page int No Number of items to show on each page. Max 50. query string No Search query. sort string Но No Technique used to sort the results.
date alphabetical videos followers
direction string Но No The direction that the results are sorted.
asc desc
filter string No Filter to apply to the results.
featured
func (*Client) GetChannelVideos ¶
func (c *Client) GetChannelVideos(channel string, params *Parameters) (*VideoData, error)
GetChannelVideos gets a list of videos in a Channel. Name Type Required Description page int No The page number to show. per_page int No Number of items to show on each page. Max 50. query string No Search query. sort string Но No Technique used to sort the results.
date alphabetical plays likes comments duration added modified_time manual
direction string Но No The direction that the results are sorted.
asc desc
filter string No Filter to apply to the results.
embeddable
filter_embeddable string No Required if filter=embeddable. Choose between only videos that are embeddable, and only videos that are not embeddable.
true false
func (*Client) GetChannels ¶
func (c *Client) GetChannels(params *Parameters) (*ChannelData, error)
GetChannels gets a list of all Channels. Name Type Required Description page int No The page number to show. per_page int No Number of items to show on each page. Max 50. query string No Search query. sort string Но No Technique used to sort the results.
date alphabetical videos followers
direction string Но No The direction that the results are sorted.
asc desc
filter string No Filter to apply to the results.
feature
func (*Client) GetContentRatings ¶
func (c *Client) GetContentRatings(params *Parameters) (*CommonsData, error)
GetContentRatings gets all valid content ratings
func (*Client) GetCreativeCommons ¶
func (c *Client) GetCreativeCommons(params *Parameters) (*CommonsData, error)
GetCreativeCommons gets all valid creative commons licenses
func (*Client) GetGroup ¶
func (c *Client) GetGroup(group string, params *Parameters) (*GroupData, error)
GetGroup gets a group
func (*Client) GetGroupUsers ¶
func (c *Client) GetGroupUsers(group string, params *Parameters) (*UserData, error)
GetGroupUsers gets a list of users that joined a Group. Name Type Required Description page int No The page number to show. per_page int No Number of items to show on each page. Max 50. query string No Search query. sort string No Technique used to sort the results.
date alphabetical
direction string No The direction that the results are sorted.
asc desc
filter string No Filter to apply to the results.
moderators
func (*Client) GetGroupVideos ¶
func (c *Client) GetGroupVideos(group string, params *Parameters) (*VideoData, error)
GetGroupVideos gets a list of videos in a Group. Name Type Required Description page int No The page number to show. per_page int No Number of items to show on each page. Max 50. query string No Search query. filter string No Filter to apply to the results.
embeddable
filter_embeddable string No Required if filter=embeddable. Choose between only videos that are embeddable, and only videos that are not embeddable.
true false
sort string No Technique used to sort the results.
date alphabetical plays likes comments duration
direction string No The direction that the results are sorted.
asc desc
func (*Client) GetGroups ¶
func (c *Client) GetGroups(params *Parameters) (*GroupData, error)
GetGroups gets a list of all groups Name Type Required Description page int No The page number to show. per_page int No Number of items to show on each page. Max 50. query string No Search query. sort string No Technique used to sort the results.
date alphabetical videos followers
direction string No The direction that the results are sorted.
asc desc
filter string No Filter to apply to the results.
featured
func (*Client) GetLanguages ¶
func (c *Client) GetLanguages(params *Parameters) (*CommonsData, error)
GetLanguages lists all valid video languages
func (*Client) GetMe ¶
func (c *Client) GetMe(params *Parameters) (*User, error)
GetMe gets information about me
func (*Client) GetMyAlbum ¶
func (c *Client) GetMyAlbum(album string, params *Parameters) (*AlbumDataElement, error)
GetMyAlbum gets info on an Album.
func (*Client) GetMyAlbumVideos ¶
func (c *Client) GetMyAlbumVideos(album string, params *Parameters) (*VideoData, error)
GetMyAlbumVideos gets a list of videos in an album Name Type Required Description page int No The page number to show. per_page int No Number of items to show on each page. Max 50. query string No Search query. filter string No Filter to apply to the results.
embeddable
filter_embeddable string No Required if filter=embeddable. Choose between only videos that are embeddable, and only videos that are not embeddable.
true false
sort string No Technique used to sort the results.
manual date alphabetical plays likes comments duration modified_time
direction string No The direction that the results are sorted.
asc desc
func (*Client) GetMyAlbums ¶
func (c *Client) GetMyAlbums(params *Parameters) (*AlbumData, error)
GetMyAlbums gets a list of user's albums Name Type Required Description page int No The page number to show. per_page int No Number of items to show on each page. Max 50. query string No Search query. sort string No Technique used to sort the results.
date alphabetical videos duration
direction string No The direction that the results are sorted.
asc desc
func (*Client) GetMyAppearances ¶
func (c *Client) GetMyAppearances(params *Parameters) (*VideoData, error)
GetMyAppearances gets all videos that a user appears in. Name Type Required Description page int No The page number to show. per_page int No Number of items to show on each page. Max 50. query string No Search query. filter string No Filter to apply to the results.
embeddable
filter_embeddable string No Required if filter=embeddable. Choose between only videos that are embeddable, and only videos that are not embeddable.
true false
sort string No Technique used to sort the results.
date alphabetical plays likes comments durection
direction string No The direction that the results are sorted.
asc desc
func (*Client) GetMyChannels ¶
func (c *Client) GetMyChannels(params *Parameters) (*ChannelData, error)
GetMyChannels gets a list of channels the user follows Name Type Required Description page int No The page number to show. per_page int No Number of items to show on each page. Max 50. query string No Search query. filter string No Filter to apply to the results.
moderated
sort string No Technique used to sort the results.
date alphabetical videos followers
direction string No The direction that the results are sorted.
asc desc
func (*Client) GetMyFeed ¶
func (c *Client) GetMyFeed(params *Parameters) (*FeedData, error)
GetMyFeed gets a list of the videos in user's feed. Name Type Required Description page int No The page number to show. per_page int No Number of items to show on each page. Max 50. offset string Yes This is necessary for proper pagination. Do not provide this value yourself, just use the pagination links provided in the feed response This method requires a token with the "private" scope.
func (*Client) GetMyFollowers ¶
func (c *Client) GetMyFollowers(params *Parameters) (*FollowersData, error)
GetMyFollowers gets a list of user's followers Name Type Required Description page int No The page number to show. per_page int No Number of items to show on each page. Max 50. query string No Search query. sort string No Technique used to sort the results.
date alphabetical
direction string No The direction that the results are sorted.
asc desc
func (*Client) GetMyFollowing ¶
func (c *Client) GetMyFollowing(params *Parameters) (*FollowersData, error)
GetMyFollowing gets a list of the users that a user is following. Name Type Required Description page int No The page number to show. per_page int No Number of items to show on each page. Max 50. query string No Search query. sort string No Technique used to sort the results.
date alphabetical
direction string No The direction that the results are sorted.
asc desc
filter string No Filter to apply to the results.
online
func (*Client) GetMyGroups ¶
func (c *Client) GetMyGroups(params *Parameters) (*GroupData, error)
GetMyGroups gets a list of groups the user has joined Name Type Required Description page int No The page number to show. per_page int No Number of items to show on each page. Max 50. query string No Search query. filter string No Filter to apply to the results.
moderated
sort string No Technique used to sort the results.
date alphabetical videos followers
direction string No The direction that the results are sorted.
asc desc
func (*Client) GetMyLikes ¶
func (c *Client) GetMyLikes(params *Parameters) (*LikesData, error)
GetMyLikes gets a list of videos that a user likes. Name Type Required Description page int No The page number to show. per_page int No Number of items to show on each page. Max 50. query string No Search query. filter string No Filter to apply to the results.
embeddable
filter_embeddable string No Required if filter=embeddable. Choose between only videos that are embeddable, and only videos that are not embeddable.
true false
sort string No Technique used to sort the results.
date alphabetical plays likes comments duration
direction string No The direction that the results are sorted.
asc desc
func (*Client) GetMyPictures ¶
func (c *Client) GetMyPictures(params *Parameters) (*PicturesData, error)
GetMyPictures gets a list of this user's portrait images.
func (*Client) GetMyPorfolios ¶
func (c *Client) GetMyPorfolios(params *Parameters) (*PortfolioData, error)
GetMyPorfolios gets a list of Portfolios created by a user. Name Type Required Description page int No The page number to show. per_page int No Number of items to show on each page. Max 50. query string No Search query. sort string No Technique used to sort the results.
date alphabetical
direction string No The direction that the results are sorted.
asc desc
func (*Client) GetMyPortfolio ¶
func (c *Client) GetMyPortfolio(portfolio string, params *Parameters) (*Portfolio, error)
GetMyPortfolio gets a portfolio
func (*Client) GetMyPortfolioVideos ¶
func (c *Client) GetMyPortfolioVideos(portfolio string, params *Parameters) (*VideoData, error)
GetMyPortfolioVideos gets the videos in this Portfolio. Name Type Required Description page int No The page number to show. per_page int No Number of items to show on each page. Max 50. sort string No Technique used to sort the results.
date alphabetical plays likes comments manual default
direction string No The direction that the results are sorted.
asc desc
func (*Client) GetMyVideo ¶
func (c *Client) GetMyVideo(video string, params *Parameters) (*VideoDataElement, error)
GetMyVideo checks if a user owns a clip.
func (*Client) GetMyVideos ¶
func (c *Client) GetMyVideos(params *Parameters) (*VideoData, error)
GetMyVideos gets a list of videos uploaded by a user. Name Type Required Description page int No The page number to show. per_page int No Number of items to show on each page. Max 50. query string No Search query. filter string No Filter to apply to the results.
embeddable playable
filter_embeddable string No Required if filter=embeddable. Choose between only videos that are embeddable, and only videos that are not embeddable.
true false
filter_playable string No Default true. Choose between only videos that are playable, and only videos that are not playable.
true false
sort string No Technique used to sort the results.
date alphabetical plays likes comments duration default modified_time
direction string No The direction that the results are sorted.
asc desc
func (*Client) GetMyWatchedVideos ¶
func (c *Client) GetMyWatchedVideos(params *Parameters) (*VideoData, error)
GetMyWatchedVideos gets a list of watched videos
func (*Client) GetRelatedVideos ¶
func (c *Client) GetRelatedVideos(video string, params *Parameters) (*VideoData, error)
GetRelatedVideos gets related videos. Name Type Required Description page int No The page number to show. per_page int No Number of items to show on each page. Max 50. filter string Yes Filter to apply to the results.
related
func (*Client) GetTag ¶
func (c *Client) GetTag(tag string, params *Parameters) (*Tag, error)
GetTag gets a tag
func (*Client) GetTagVideos ¶
func (c *Client) GetTagVideos(tag string, params *Parameters) (*VideoData, error)
GetTagVideos gets a list of videos associated with a tag.
func (*Client) GetToken ¶
GetToken exchange a code for an access token. This code should exist on your redirect_uri
func (*Client) GetUser ¶
func (c *Client) GetUser(user string, params *Parameters) (*User, error)
GetUser gets information for a user
func (*Client) GetUserAlbum ¶
func (c *Client) GetUserAlbum(user string, album string, params *Parameters) (*AlbumDataElement, error)
GetUserAlbum gets info on an Album.
func (*Client) GetUserAlbumVideos ¶
func (c *Client) GetUserAlbumVideos(user, album string, params *Parameters) (*VideoData, error)
GetUserAlbumVideos gets a list of videos in an album Name Type Required Description page int No The page number to show. per_page int No Number of items to show on each page. Max 50. query string No Search query. filter string No Filter to apply to the results.
embeddable
filter_embeddable string No Required if filter=embeddable. Choose between only videos that are embeddable, and only videos that are not embeddable.
true false
sort string No Technique used to sort the results.
manual date alphabetical plays likes comments duration modified_time
direction string No The direction that the results are sorted.
asc desc
func (*Client) GetUserAlbums ¶
func (c *Client) GetUserAlbums(user string, params *Parameters) (*AlbumData, error)
GetUserAlbums gets a list of user's albums Name Type Required Description page int No The page number to show. per_page int No Number of items to show on each page. Max 50. query string No Search query. sort string No Technique used to sort the results.
date alphabetical videos duration
direction string No The direction that the results are sorted.
asc desc
func (*Client) GetUserAppearances ¶
func (c *Client) GetUserAppearances(user string, params *Parameters) (*VideoData, error)
GetUserAppearances gets all videos that a user appears in. Name Type Required Description page int No The page number to show. per_page int No Number of items to show on each page. Max 50. query string No Search query. filter string No Filter to apply to the results.
embeddable
filter_embeddable string No Required if filter=embeddable. Choose between only videos that are embeddable, and only videos that are not embeddable.
true false
sort string No Technique used to sort the results.
date alphabetical plays likes comments durection
direction string No The direction that the results are sorted.
asc desc
func (*Client) GetUserChannels ¶
func (c *Client) GetUserChannels(user string, params *Parameters) (*ChannelData, error)
GetUserChannels gets a list of channels the user follows Name Type Required Description page int No The page number to show. per_page int No Number of items to show on each page. Max 50. query string No Search query. filter string No Filter to apply to the results.
moderated
sort string No Technique used to sort the results.
date alphabetical videos followers
direction string No The direction that the results are sorted.
asc desc
func (*Client) GetUserFeed ¶
func (c *Client) GetUserFeed(user string, params *Parameters) (*FeedData, error)
GetUserFeed gets a list of the videos in user's feed. Name Type Required Description page int No The page number to show. per_page int No Number of items to show on each page. Max 50. offset string Yes This is necessary for proper pagination. Do not provide this value yourself, just use the pagination links provided in the feed response This method requires a token with the "private" scope.
func (*Client) GetUserFollowers ¶
func (c *Client) GetUserFollowers(user string, params *Parameters) (*FollowersData, error)
GetUserFollowers gets a list of user's followers Name Type Required Description page int No The page number to show. per_page int No Number of items to show on each page. Max 50. query string No Search query. sort string No Technique used to sort the results.
date alphabetical
direction string No The direction that the results are sorted.
asc desc
func (*Client) GetUserFollowing ¶
func (c *Client) GetUserFollowing(user string, params *Parameters) (*FollowersData, error)
GetUserFollowing gets a list of the users that a user is following. Name Type Required Description page int No The page number to show. per_page int No Number of items to show on each page. Max 50. query string No Search query. sort string No Technique used to sort the results.
date alphabetical
direction string No The direction that the results are sorted.
asc desc
filter string No Filter to apply to the results.
online
func (*Client) GetUserLikes ¶
func (c *Client) GetUserLikes(user string, params *Parameters) (*LikesData, error)
GetUserLikes gets a list of videos that a user likes. Name Type Required Description page int No The page number to show. per_page int No Number of items to show on each page. Max 50. query string No Search query. filter string No Filter to apply to the results.
embeddable
filter_embeddable string No Required if filter=embeddable. Choose between only videos that are embeddable, and only videos that are not embeddable.
true false
sort string No Technique used to sort the results.
date alphabetical plays likes comments duration
direction string No The direction that the results are sorted.
asc desc
func (*Client) GetUserPictures ¶
func (c *Client) GetUserPictures(user string, params *Parameters) (*PicturesData, error)
GetUserPictures gets a list of this user's portrait images.
func (*Client) GetUserPorfolios ¶
func (c *Client) GetUserPorfolios(user string, params *Parameters) (*PortfolioData, error)
GetUserPorfolios gets a list of Portfolios created by a user. Name Type Required Description page int No The page number to show. per_page int No Number of items to show on each page. Max 50. query string No Search query. sort string No Technique used to sort the results.
date alphabetical
direction string No The direction that the results are sorted.
asc desc
func (*Client) GetUserPortfolio ¶
func (c *Client) GetUserPortfolio(user, portfolio string, params *Parameters) (*Portfolio, error)
GetUserPortfolio gets a portfolio
func (*Client) GetUserPortfolioVideos ¶
func (c *Client) GetUserPortfolioVideos(user, portfolio string, params *Parameters) (*VideoData, error)
GetUserPortfolioVideos gets the videos in this Portfolio. Name Type Required Description page int No The page number to show. per_page int No Number of items to show on each page. Max 50. sort string No Technique used to sort the results.
date alphabetical plays likes comments manual default
direction string No The direction that the results are sorted.
asc desc
func (*Client) GetUserVideo ¶
func (c *Client) GetUserVideo(user, video string, params *Parameters) (*VideoDataElement, error)
GetUserVideo checks if a user owns a clip.
func (*Client) GetUserVideos ¶
func (c *Client) GetUserVideos(user, params *Parameters) (*VideoData, error)
GetUserVideos gets a list of videos uploaded by a user. Name Type Required Description page int No The page number to show. per_page int No Number of items to show on each page. Max 50. query string No Search query. filter string No Filter to apply to the results.
embeddable playable
filter_embeddable string No Required if filter=embeddable. Choose between only videos that are embeddable, and only videos that are not embeddable.
true false
filter_playable string No Default true. Choose between only videos that are playable, and only videos that are not playable.
true false
sort string No Technique used to sort the results.
date alphabetical plays likes comments duration default modified_time
direction string No The direction that the results are sorted.
asc desc
func (*Client) GetUserWatchLater ¶
func (c *Client) GetUserWatchLater(user string, params *Parameters) (*VideoDataElement, error)
GetUserWatchLater gets the authenticated user's Watch Later queue. Name Type Required Description page int No The page number to show. per_page int No Number of items to show on each page. Max 50. query string No Search query. filter string No Filter to apply to the results.
embeddable
filter_embeddable string No Required if filter=embeddable. Choose between only videos that are embeddable, and only videos that are not embeddable.
true false
sort string No Technique used to sort the results.
date alphabetical plays likes comments duration
direction string No The direction that the results are sorted.
asc desc
func (*Client) GetUserWatchedVideos ¶
func (c *Client) GetUserWatchedVideos(user string, params *Parameters) (*VideoData, error)
GetUserWatchedVideos removes a video from the Portfolio. This method requires a token with the "edit" scope.
func (*Client) GetUsers ¶
func (c *Client) GetUsers(params *Parameters) (*UserData, error)
GetUsers searches for users Name Type Required Description page int No The page number to show. per_page int No Number of items to show on each page. Max 50. query string Yes Search query. sort string No Technique used to sort the results.
relevant date alphabetical
direction string No The direction that the results are sorted.
asc desc
func (*Client) GetVideo ¶
func (c *Client) GetVideo(video string, params *Parameters) (*VideoDataElement, error)
GetVideo gets a video.
func (*Client) GetVideoCategories ¶
func (c *Client) GetVideoCategories(video string, params *Parameters) (*CategoryData, error)
GetVideoCategories gets a list of all categories this video is in. Name Type Required Description page int No The page number to show. per_page int No Number of items to show on each page. Max 50.
func (*Client) GetVideoCommentReplies ¶
func (c *Client) GetVideoCommentReplies(video, comment string, params *Parameters) (*CommentData, error)
GetVideoCommentReplies gets comments on this video. Name Type Required Description page int No The page number to show. per_page int No Number of items to show on each page. Max 50.
func (*Client) GetVideoComments ¶
func (c *Client) GetVideoComments(video string, params *Parameters) (*CommentData, error)
GetVideoComments gets comments on this video. Name Type Required Description page int No The page number to show. per_page int No Number of items to show on each page. Max 50. query string No Search query. sort string No Technique used to sort the results.
date alphabetical
direction string No The direction that the results are sorted.
asc desc
func (*Client) GetVideoCredit ¶
func (c *Client) GetVideoCredit(video, credit string, params *Parameters) (*CreditsDataElement, error)
GetVideoCredit gets a single credit.
func (*Client) GetVideoCredits ¶
func (c *Client) GetVideoCredits(video string, params *Parameters) (*CreditsData, error)
GetVideoCredits gets a list of users credited on a video. Name Type Required Description page int No The page number to show. per_page int No Number of items to show on each page. Max 50. query string No Search query. sort string No Technique used to sort the results.
date alphabetical
direction string No The direction that the results are sorted.
asc desc
func (*Client) GetVideoLikes ¶
func (c *Client) GetVideoLikes(video string, params *Parameters) (*LikesData, error)
GetVideoLikes gets a list of the users who liked this video. Name Type Required Description page int No The page number to show. per_page int No Number of items to show on each page. Max 50. query string No Search query. sort string No Technique used to sort the results.
date alphabetical
direction string No The direction that the results are sorted.
asc desc
func (*Client) GetVideoPicture ¶
func (c *Client) GetVideoPicture(video, picture string, params *Parameters) (*Picture, error)
GetVideoPicture gets a single picture resource for a video
func (*Client) GetVideoPictures ¶
func (c *Client) GetVideoPictures(video string, params *Parameters) (*PicturesData, error)
GetVideoPictures gets a list of this video's past and present pictures.
func (*Client) GetVideoTags ¶
func (c *Client) GetVideoTags(video string, params *Parameters) (*TagsData, error)
GetVideoTags lists all of the tags on the video
func (*Client) GetVideoUsers ¶
func (c *Client) GetVideoUsers(video string, params *Parameters) (*UserData, error)
GetVideoUsers gets all users that are allowed to see this video.
func (*Client) GetVideos ¶
func (c *Client) GetVideos(params *Parameters) (*VideoData, error)
GetVideos searches for videos Name Type Required Description page int No The page number to show. per_page int No Number of items to show on each page. Max 50. query string Yes Search query. sort string No Technique used to sort the results.
relevant date alphabetical plays likes comments duration
direction string No The direction that the results are sorted.
asc desc
filter string No Filter to apply to the results. The CC filters will show only those videos with the applicable creative commons licenses. See our Creative Commons page for more.
CC CC-BY CC-BY-SA CC-BY-ND CC-BY-NC CC-BY-NC-SA CC-BY-NC-ND in-progress
func (*Client) GetWatchLater ¶
func (c *Client) GetWatchLater(params *Parameters) (*VideoDataElement, error)
GetWatchLater gets the authenticated user's Watch Later queue. Name Type Required Description page int No The page number to show. per_page int No Number of items to show on each page. Max 50. query string No Search query. filter string No Filter to apply to the results.
embeddable
filter_embeddable string No Required if filter=embeddable. Choose between only videos that are embeddable, and only videos that are not embeddable.
true false
sort string No Technique used to sort the results.
date alphabetical plays likes comments duration
direction string No The direction that the results are sorted.
asc desc
func (*Client) MeEditPicture ¶
func (c *Client) MeEditPicture(picture string, params *Parameters) (*Picture, error)
MeEditPicture edits a portrait
func (*Client) MeFollowCategory ¶
func (c *Client) MeFollowCategory(category string, params *Parameters) error
MeFollowCategory subscribes to a category This method requires a token with the "interact" scope.
func (*Client) MeFollowChannel ¶
func (c *Client) MeFollowChannel(channel string, params *Parameters) error
MeFollowChannel subscribes to a Channel. This method requires a token with the "interact" scope.
func (*Client) MeFollowGroup ¶
func (c *Client) MeFollowGroup(group string, params *Parameters) error
MeFollowGroup joins a group This method requires a token with the "interact" scope.
func (*Client) MeFollowUser ¶
func (c *Client) MeFollowUser(user string, params *Parameters) error
MeFollowUser follows an user This method requires a token with the "interact" scope.
func (*Client) MeFollowingCategory ¶
func (c *Client) MeFollowingCategory(category string, params *Parameters) (bool, error)
MeFollowingCategory checks if a user follows a Category.
func (*Client) MeFollowingChannel ¶
func (c *Client) MeFollowingChannel(channel string, params *Parameters) (bool, error)
MeFollowingChannel checks if a user follows a Channel.
func (*Client) MeFollowingGroup ¶
func (c *Client) MeFollowingGroup(group string, params *Parameters) (bool, error)
MeFollowingGroup checks if an user has joined a group
func (*Client) MeFollowingUser ¶
func (c *Client) MeFollowingUser(user string, params *Parameters) (bool, error)
MeFollowingUser checks if a user follows another user.
func (*Client) MeHasPicture ¶
func (c *Client) MeHasPicture(picture string, params *Parameters) (*Picture, error)
MeHasPicture checks if a user has a portrait.
func (*Client) MeLikeVideo ¶
func (c *Client) MeLikeVideo(video string, params *Parameters) error
MeLikeVideo likes a video This method requires a token with the "interact" scope.
func (*Client) MeLikingVideo ¶
func (c *Client) MeLikingVideo(video string, params *Parameters) (bool, error)
MeLikingVideo checks if a user likes a video.
func (*Client) MeUnfollowCategory ¶
func (c *Client) MeUnfollowCategory(category string, params *Parameters) error
MeUnfollowCategory unsubscribes from a category This method requires a token with the "interact" scope.
func (*Client) MeUnfollowChannel ¶
func (c *Client) MeUnfollowChannel(channel string, params *Parameters) error
MeUnfollowChannel unsubscribes from a Channel. This method requires a token with the "interact" scope.
func (*Client) MeUnfollowGroup ¶
func (c *Client) MeUnfollowGroup(group string, params *Parameters) error
MeUnfollowGroup leaves a group This method requires a token with the "interact" scope.
func (*Client) MeUnfollowUser ¶
func (c *Client) MeUnfollowUser(user string, params *Parameters) error
MeUnfollowUser unfollows an user This method requires a token with the "interact" scope.
func (*Client) MeUnlikeVideo ¶
func (c *Client) MeUnlikeVideo(video string, params *Parameters) error
MeUnlikeVideo unlikes a video This method requires a token with the "interact" scope.
func (*Client) MeUploadVideo ¶
func (c *Client) MeUploadVideo(params *Parameters) (*Upload, error)
MeUploadVideo begins the video upload process. This method requires a token with the "upload" scope.
func (*Client) MyPortfoliosAddVideo ¶
func (c *Client) MyPortfoliosAddVideo(portfolio, video string, params *Parameters) error
MyPortfoliosAddVideo adds a video to the Portfolio. This method requires a token with the "edit" scope.
func (*Client) MyPortfoliosContaintsVideo ¶
func (c *Client) MyPortfoliosContaintsVideo(portfolio, video string, params *Parameters) (bool, error)
MyPortfoliosContaintsVideo checks if a Portfolio contains a video.
func (*Client) MyPortfoliosDeleteVideos ¶
func (c *Client) MyPortfoliosDeleteVideos(portfolio, video string, params *Parameters) error
MyPortfoliosDeleteVideos removes a video from the Portfolio. This method requires a token with the "edit" scope.
func (*Client) Patch ¶
Patch performs a PATCH request to the Vimeo API with urlStr path and params as body.
func (*Client) PatchChannel ¶
func (c *Client) PatchChannel(channel string, params *Parameters) (*ChannelDataElement, error)
PatchChannel edits a Channel's information Name Type Required Description name string No The Channel's new name description string No The Channel's new description privacy string No The Channel's new privacy level
anybody users
func (*Client) Post ¶
Post performs a POST request to the Vimeo API with urlStr path and params as body.
func (*Client) Put ¶
Put performs a PUT request to the Vimeo API with urlStr path and params as body.
func (*Client) PutInMyAlbums ¶
func (c *Client) PutInMyAlbums(params *Parameters) (*AlbumDataElement, error)
PutInMyAlbums create an Album. This method requires a token with the "create" scope. Name Type Required Description name string Yes The Album title description string Yes The Album description privacy string No The Album's privacy level
anybody password
password string No Required if privacy=password. The Album's password sort string No The default sort order of an Album's videos
arranged newest oldest plays comments likes added_first added_last alphabetical
func (*Client) PutInUserAlbums ¶
func (c *Client) PutInUserAlbums(user string, params *Parameters) (*AlbumDataElement, error)
PutInUserAlbums create an Album. This method requires a token with the "create" scope. Name Type Required Description name string Yes The Album title description string Yes The Album description privacy string No The Album's privacy level
anybody password
password string No Required if privacy=password. The Album's password sort string No The default sort order of an Album's videos
arranged newest oldest plays comments likes added_first added_last alphabetical
func (*Client) PutVideoInChannel ¶
func (c *Client) PutVideoInChannel(channel, video string, params *Parameters) error
PutVideoInChannel adds a video to a Channel.
func (*Client) PutVideoInGroup ¶
func (c *Client) PutVideoInGroup(group, video string, params *Parameters) error
PutVideoInGroup adds a video to a Group This method requires a token with the "edit" scope.
func (*Client) PutVideoInMyAlbum ¶
func (c *Client) PutVideoInMyAlbum(album, video string, params *Parameters) error
PutVideoInMyAlbum adds a video to an Album. This method requires a token with the "edit" scope.
func (*Client) PutVideoInUserAlbum ¶
func (c *Client) PutVideoInUserAlbum(user, album, video string, params *Parameters) error
PutVideoInUserAlbum adds a video to an Album. This method requires a token with the "edit" scope.
func (*Client) ReplaceVideo ¶
func (c *Client) ReplaceVideo(video string, params *Parameters) error
ReplaceVideo gets an upload ticket to replace this video file. This method requires a token with the "upload" scope. Name Type Required Description type string Yes Upload type
POST streaming
redirect_url string Yes The app redirect URL
func (*Client) ReplyToCommentVideo ¶
func (c *Client) ReplyToCommentVideo(video, comment string, params *Parameters) (*CommentDataElement, error)
ReplyToCommentVideo posts a reply to a comment on the video
Name Type Required Description text string Yes The comment's new text
func (*Client) UploadPicture ¶
func (c *Client) UploadPicture(params *Parameters) (*Picture, error)
UploadPicture creaetes a new picture resource. This method requires a token with the "upload" scope.
func (*Client) UserAddWatchLater ¶
func (c *Client) UserAddWatchLater(user, video string, params *Parameters) error
UserAddWatchLater adds a video to the authenticated user's watch later list. This method requires a token with the "interact" scope.
func (*Client) UserEditPicture ¶
func (c *Client) UserEditPicture(user, picture string, params *Parameters) (*Picture, error)
UserEditPicture edits a portrait
func (*Client) UserFollowCategory ¶
func (c *Client) UserFollowCategory(user, category string, params *Parameters) error
UserFollowCategory subscribes to a category This method requires a token with the "interact" scope.
func (*Client) UserFollowChannel ¶
func (c *Client) UserFollowChannel(user, channel string, params *Parameters) error
UserFollowChannel subscribes to a Channel. This method requires a token with the "interact" scope.
func (*Client) UserFollowGroup ¶
func (c *Client) UserFollowGroup(user, group string, params *Parameters) error
UserFollowGroup joins a group This method requires a token with the "interact" scope.
func (*Client) UserFollowUser ¶
func (c *Client) UserFollowUser(user, followed string, params *Parameters) error
UserFollowUser follows an user his method requires a token with the "interact" scope.
func (*Client) UserFollowingCategory ¶
func (c *Client) UserFollowingCategory(user, category string, params *Parameters) (bool, error)
UserFollowingCategory checks if a user follows a Category.
func (*Client) UserFollowingChannel ¶
func (c *Client) UserFollowingChannel(user, channel string, params *Parameters) (bool, error)
UserFollowingChannel checks if a user follows a Channel.
func (*Client) UserFollowingGroup ¶
func (c *Client) UserFollowingGroup(user, group string, params *Parameters) (bool, error)
UserFollowingGroup checks if an user has joined a group
func (*Client) UserFollowingUser ¶
func (c *Client) UserFollowingUser(user, followed string, params *Parameters) (bool, error)
UserFollowingUser checks if a user follows another user.
func (*Client) UserHasPicture ¶
func (c *Client) UserHasPicture(user, picture string, params *Parameters) (*Picture, error)
UserHasPicture checks if a user has a portrait.
func (*Client) UserLikeVideo ¶
func (c *Client) UserLikeVideo(user, video string, params *Parameters) error
UserLikeVideo likes a video This method requires a token with the "interact" scope.
func (*Client) UserLikingVideo ¶
func (c *Client) UserLikingVideo(user, video string, params *Parameters) (bool, error)
UserLikingVideo checks if a user likes a video.
func (*Client) UserMyGroups ¶
func (c *Client) UserMyGroups(user string, params *Parameters) (*GroupData, error)
UserMyGroups gets a list of groups the user has joined Name Type Required Description page int No The page number to show. per_page int No Number of items to show on each page. Max 50. query string No Search query. filter string No Filter to apply to the results.
moderated
sort string No Technique used to sort the results.
date alphabetical videos followers
direction string No The direction that the results are sorted.
asc desc
func (*Client) UserPortfoliosAddVideo ¶
func (c *Client) UserPortfoliosAddVideo(user, portfolio, video string, params *Parameters) error
UserPortfoliosAddVideo adds a video to the Portfolio. This method requires a token with the "edit" scope.
func (*Client) UserPortfoliosContaintsVideo ¶
func (c *Client) UserPortfoliosContaintsVideo(user, portfolio, video string, params *Parameters) (bool, error)
UserPortfoliosContaintsVideo checks if a Portfolio contains a video.
func (*Client) UserPortfoliosDeleteVideos ¶
func (c *Client) UserPortfoliosDeleteVideos(user, portfolio, video string, params *Parameters) error
UserPortfoliosDeleteVideos deletes a video from the Portfolio. This method requires a token with the "interact" scope.
func (*Client) UserUnfollowCategory ¶
func (c *Client) UserUnfollowCategory(user, category string, params *Parameters) error
UserUnfollowCategory unsubscribes from a category This method requires a token with the "interact" scope.
func (*Client) UserUnfollowChannel ¶
func (c *Client) UserUnfollowChannel(user, channel string, params *Parameters) error
UserUnfollowChannel unsubscribes from a Channel. This method requires a token with the "interact" scope.
func (*Client) UserUnfollowGroup ¶
func (c *Client) UserUnfollowGroup(user, group string, params *Parameters) error
UserUnfollowGroup leaves a group This method requires a token with the "interact" scope.
func (*Client) UserUnfollowUser ¶
func (c *Client) UserUnfollowUser(user, followed string, params *Parameters) error
UserUnfollowUser unfollows an user This method requires a token with the "interact" scope.
func (*Client) UserUnlikeVideo ¶
func (c *Client) UserUnlikeVideo(user, video string, params *Parameters) error
UserUnlikeVideo unlikes a video This method requires a token with the "interact" scope.
func (*Client) UserUploadPicture ¶
func (c *Client) UserUploadPicture(user string, params *Parameters) (*Picture, error)
UserUploadPicture creaetes a new picture resource. This method requires a token with the "upload" scope.
func (*Client) UserUploadVideo ¶
func (c *Client) UserUploadVideo(user string, params *Parameters) (*AlbumDataElement, error)
UserUploadVideo begins the video upload process. This method requires a token with the "upload" scope.
func (*Client) VerifyToken ¶
func (c *Client) VerifyToken(params *Parameters) (*Oauth, error)
VerifyToken verifies the users token
func (*Client) VideoPutTag ¶
func (c *Client) VideoPutTag(video, tag string, params *Parameters) error
VideoPutTag tags a video. This method requires a token with the "edit" scope.
type Parameters ¶
Parameters given to the functions
func (Parameters) BuildRequestURL ¶
func (params Parameters) BuildRequestURL() url.Values
BuildRequestURL parses Parameters to url.Values