Blame - docs/dyn/youtube_v3.search.html - platform/external/python/google-api-python-client

<code><a href="#list">list(part, forDeveloper=None, locationRadius=None, videoDefinition=None, order=None, forContentOwner=None, videoType=None, topicId=None, videoEmbeddable=None, videoDuration=None, forMine=None, maxResults=None, relevanceLanguage=None, publishedAfter=None, pageToken=None, q=None, regionCode=None, onBehalfOfContentOwner=None, location=None, videoDimension=None, type=None, videoSyndicated=None, channelId=None, eventType=None, publishedBefore=None, videoCategoryId=None, channelType=None, relatedToVideoId=None, videoLicense=None, safeSearch=None, videoCaption=None, x__xgafv=None)</a></code></p>

79

<p class="firstline">Retrieves a list of search resources</p>

John Asmuth

614db98

2014-04-24 15:46:26 -0400

[diff] [blame]

80

81

<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>

82

<p class="firstline">Retrieves the next page of results.</p>

83

<h3>Method Details</h3>

84

Bu Sun Kim

d059ad8

2020-07-22 17:02:09 -0700

[diff] [blame^]

85

<code class="details" id="list">list(part, forDeveloper=None, locationRadius=None, videoDefinition=None, order=None, forContentOwner=None, videoType=None, topicId=None, videoEmbeddable=None, videoDuration=None, forMine=None, maxResults=None, relevanceLanguage=None, publishedAfter=None, pageToken=None, q=None, regionCode=None, onBehalfOfContentOwner=None, location=None, videoDimension=None, type=None, videoSyndicated=None, channelId=None, eventType=None, publishedBefore=None, videoCategoryId=None, channelType=None, relatedToVideoId=None, videoLicense=None, safeSearch=None, videoCaption=None, x__xgafv=None)</code>

86

<pre>Retrieves a list of search resources

John Asmuth

614db98

2014-04-24 15:46:26 -0400

[diff] [blame]

87

88

Args:

Bu Sun Kim

d059ad8

2020-07-22 17:02:09 -0700

[diff] [blame^]

89

part: string, The <code><strong>part</strong></code> parameter specifies a

90

comma-separated list of one or more <code>search</code> resource properties

91

that the API response will include. Set the parameter value to

92

<code>snippet</code>. (required) (repeated)

93

forDeveloper: boolean, Restrict the search to only retrieve videos uploaded using the project id

94

of the authenticated user.

95

locationRadius: string, Filter on distance from the location (specified above).

96

videoDefinition: string, Filter on the definition of the videos.

97

order: string, Sort order of the results.

98

forContentOwner: boolean, Search owned by a content owner.

99

videoType: string, Filter on videos of a specific type.

100

topicId: string, Restrict results to a particular topic.

101

videoEmbeddable: string, Filter on embeddable videos.

102

videoDuration: string, Filter on the duration of the videos.

103

forMine: boolean, Search for the private videos of the authenticated user.

104

maxResults: integer, The <code><strong>maxResults</strong></code> parameter specifies the

105

maximum number of items that should be returned in the result set.

106

relevanceLanguage: string, Return results relevant to this language.

107

publishedAfter: string, Filter on resources published after this date.

108

pageToken: string, The <code><strong>pageToken</strong></code> parameter identifies a specific

109

page in the result set that should be returned. In an API response, the

110

<code>nextPageToken</code> and <code>prevPageToken</code> properties

111

identify other pages that could be retrieved.

112

q: string, Textual search terms to match.

113

regionCode: string, Display the content as seen by viewers in this country.

114

onBehalfOfContentOwner: string, <strong>Note:</strong> This parameter is intended exclusively for YouTube

115

content partners.<br><br>The

116

<code><strong>onBehalfOfContentOwner</strong></code> parameter indicates

117

that the

118

request's authorization credentials identify a YouTube CMS user who is

119

acting on behalf of the content owner specified in the parameter value.

120

This parameter is intended for YouTube content partners that own and manage

121

many different YouTube channels. It allows content owners to authenticate

122

once and get access to all their video and channel data, without having to

123

provide authentication credentials for each individual channel. The CMS

124

account that the user authenticates with must be linked to the specified

125

YouTube content owner.

126

location: string, Filter on location of the video

127

videoDimension: string, Filter on 3d videos.

128

type: string, Restrict results to a particular set of resource types from One Platform. (repeated)

129

videoSyndicated: string, Filter on syndicated videos.

130

channelId: string, Filter on resources belonging to this channelId.

131

eventType: string, Filter on the livestream status of the videos.

132

publishedBefore: string, Filter on resources published before this date.

133

videoCategoryId: string, Filter on videos in a specific category.

134

channelType: string, Add a filter on the channel search.

135

relatedToVideoId: string, Search related to a resource.

136

videoLicense: string, Filter on the license of the videos.

137

safeSearch: string, Indicates whether the search results should include restricted content as

138

well as standard content.

139

videoCaption: string, Filter on the presence of captions on the videos.

140

x__xgafv: string, V1 error format.

John Asmuth

614db98

2014-04-24 15:46:26 -0400

[diff] [blame]

141

Allowed values

Bu Sun Kim

d059ad8

2020-07-22 17:02:09 -0700

[diff] [blame^]

142

1 - v1 error format

143

2 - v2 error format

John Asmuth

614db98

2014-04-24 15:46:26 -0400

[diff] [blame]

144

145

Returns:

146

An object of the form:

147

148

{

Bu Sun Kim

d059ad8

2020-07-22 17:02:09 -0700

[diff] [blame^]

149

"nextPageToken": "A String", # The token that can be used as the value of the <code>pageToken</code>

150

# parameter to retrieve the next page in the result set.

151

"visitorId": "A String", # The <code>visitorId</code> identifies the visitor.

152

"pageInfo": { # Paging details for lists of resources, including total number of items # General pagination information.

153

# available and number of resources returned in a single page.

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

154

"resultsPerPage": 42, # The number of results included in the API response.

155

"totalResults": 42, # The total number of results in the result set.

John Asmuth

614db98

2014-04-24 15:46:26 -0400

[diff] [blame]

156

},

Bu Sun Kim

d059ad8

2020-07-22 17:02:09 -0700

[diff] [blame^]

157

"etag": "A String", # Etag of this resource.

158

"eventId": "A String", # Serialized EventId of the request which produced this response.

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

159

"tokenPagination": { # Stub token pagination template to suppress results.

John Asmuth

614db98

2014-04-24 15:46:26 -0400

[diff] [blame]

160

},

Bu Sun Kim

d059ad8

2020-07-22 17:02:09 -0700

[diff] [blame^]

161

"prevPageToken": "A String", # The token that can be used as the value of the <code>pageToken</code>

162

# parameter to retrieve the previous page in the result set.

163

"regionCode": "A String",

164

"kind": "youtube#searchListResponse", # Identifies what kind of resource this is. Value: the fixed string

165

# <code>"youtube#searchListResponse"</code>.

166

"items": [ # Pagination information for token pagination.

167

{ # A search result contains information about a YouTube video, channel, or

168

# playlist that matches the search parameters specified in an API request.

169

# While a search result points to a uniquely identifiable resource, like a

170

# video, it does not have its own persistent data.

171

"kind": "youtube#searchResult", # Identifies what kind of resource this is. Value: the fixed string

172

# <code>"youtube#searchResult"</code>.

173

"snippet": { # Basic details about a search result, including title, description and # The <code>snippet</code> object contains basic details about a search

174

# result, such as its title or description. For example, if the search result

175

# is a video, then the title will be the

176

# video's title and the description will be the video's description.

177

# thumbnails of the item referenced by the search result.

178

"description": "A String", # A description of the search result.

179

"channelTitle": "A String", # The title of the channel that published the resource that the search result

180

# identifies.

181

"publishedAt": "A String", # The creation date and time of the resource that the search result

182

# identifies. The value is specified in <a

183

# href="//www.w3.org/TR/NOTE-datetime">ISO 8601</a>

184

# format.

185

"thumbnails": { # Internal representation of thumbnails for a YouTube resource. # A map of thumbnail images associated with the search result. For each

186

# object in the map, the key is the name of the thumbnail image, and the

187

# value is an object that contains other information about the thumbnail.

188

"medium": { # A thumbnail is an image representing a YouTube resource. # The medium quality image for this resource.

189

"width": 42, # (Optional) Width of the thumbnail image.

190

"url": "A String", # The thumbnail image's URL.

191

"height": 42, # (Optional) Height of the thumbnail image.

192

},

193

"standard": { # A thumbnail is an image representing a YouTube resource. # The standard quality image for this resource.

194

"width": 42, # (Optional) Width of the thumbnail image.

195

"url": "A String", # The thumbnail image's URL.

196

"height": 42, # (Optional) Height of the thumbnail image.

197

},

198

"default": { # A thumbnail is an image representing a YouTube resource. # The default image for this resource.

199

"width": 42, # (Optional) Width of the thumbnail image.

200

"url": "A String", # The thumbnail image's URL.

201

"height": 42, # (Optional) Height of the thumbnail image.

202

},

203

"maxres": { # A thumbnail is an image representing a YouTube resource. # The maximum resolution quality image for this resource.

204

"width": 42, # (Optional) Width of the thumbnail image.

205

"url": "A String", # The thumbnail image's URL.

206

"height": 42, # (Optional) Height of the thumbnail image.

207

},

208

"high": { # A thumbnail is an image representing a YouTube resource. # The high quality image for this resource.

209

"width": 42, # (Optional) Width of the thumbnail image.

210

"url": "A String", # The thumbnail image's URL.

211

"height": 42, # (Optional) Height of the thumbnail image.

212

},

213

},

214

"title": "A String", # The title of the search result.

215

"liveBroadcastContent": "A String", # It indicates if the resource (video or channel) has upcoming/active live

216

# broadcast content. Or it's "none" if there is not any upcoming/active

217

# live broadcasts.

218

"channelId": "A String", # The value that YouTube uses to uniquely identify the channel that

219

# published the resource that the search result identifies.

220

},

221

"id": { # A resource id is a generic reference that points to another YouTube resource. # The <code>id</code> object contains information that can be used to

222

# uniquely identify the resource that matches the search request.

223

"kind": "A String", # The type of the API resource.

224

"videoId": "A String", # The ID that YouTube uses to uniquely identify the referred resource, if

225

# that resource is a video. This property is only present if the

226

# <code>resourceId.kind</code> value is <code>youtube#video</code>.

227

"channelId": "A String", # The ID that YouTube uses to uniquely identify the referred resource, if