YouTube Connector Initial Release

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Id

The id parameter identifies the caption track that is being deleted. The value is a caption track ID as identified by the id property in a caption resource.

Onbehalfof

ID of the Google+ Page for the channel that the request is be on behalf of

Onbehalfofcontentowner

The content owner's external ID on which behalf the user is acting on. Ifnnot set, the user is acting for himself (his own channel).

Response Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Onbehalfof

ID of the Google+ Page for the channel that the request is be on behalf of

Onbehalfofcontentowner

The content owner's external ID on which behalf the user is acting on. Ifnnot set, the user is acting for himself (his own channel).

Tfmt

The tfmt parameter specifies that the caption track should be returned in a specific format. If the parameter is not included in the request, the track is returned in its original format.

Tlang

The tlang parameter specifies that the API response should return a translation of the specified caption track. The parameter value is an ISO 639-1 two-letter language code that identifies the desired caption language. The translation is generated by using machine translation, such as Google Translate.

Id

The id parameter identifies the caption track that is being retrieved. The value is a caption track ID as identified by the id property in a caption resource.

Response Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Id

The id parameter identifies the caption track that is being deleted. The value is a caption track ID as identified by the id property in a caption resource.

Response Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Banauthor

The banAuthor parameter lets you indicate that you want to automatically reject any additional comments written by the comment's author. Set the parameter value to true to ban the author.nnNote: This parameter is only valid if the moderationStatus parameter is also set to rejected.

Id

The id parameter identifies the caption track that is being deleted. The value is a caption track ID as identified by the id property in a caption resource.

Moderationstatus

Set this parameter to limit the returned comment threads to a particular moderation state.nnNote: This parameter is not supported for use in conjunction with the id parameter.

Response Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Id

The id parameter identifies the caption track that is being deleted. The value is a caption track ID as identified by the id property in a caption resource.

Response Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Onbehalfofcontentowner

The content owner's external ID on which behalf the user is acting on. Ifnnot set, the user is acting for himself (his own channel).

Jobid

The ID of the job to delete.

Response Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Includesystemmanaged

If set to true, also system-managed jobs will be returned; otherwise onlynuser-created jobs will be returned. System-managed jobs can neither benmodified nor deleted.

Onbehalfofcontentowner

The content owner's external ID on which behalf the user is acting on. Ifnnot set, the user is acting for himself (his own channel).

Pagesize

Requested page size. Server may return fewer jobs than requested.nIf unspecified, server will pick an appropriate default.

Pagetoken

A token identifying a page of results the server should return. Typically,nthis is the value ofnListReportTypesResponse.next_page_tokennreturned in response to the previous call to the ListJobs method.

Response Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Createdafter

If set, only reports created after the specified date/time are returned.

Onbehalfofcontentowner

The content owner's external ID on which behalf the user is acting on. Ifnnot set, the user is acting for himself (his own channel).

Pagesize

Requested page size. Server may return fewer jobs than requested.nIf unspecified, server will pick an appropriate default.

Pagetoken

A token identifying a page of results the server should return. Typically,nthis is the value ofnListReportTypesResponse.next_page_tokennreturned in response to the previous call to the ListJobs method.

Starttimeatorafter

If set, only reports whose start time is greater than or equal thenspecified date/time are returned.

Starttimebefore

If set, only reports whose start time is smaller than the specifiedndate/time are returned.

Jobid

The ID of the job to delete.

Response Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Onbehalfofcontentowner

The content owner's external ID on which behalf the user is acting on. Ifnnot set, the user is acting for himself (his own channel).

Jobid

The ID of the job to delete.

Reportid

The ID of the report to retrieve.

Response Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Id

The id parameter identifies the caption track that is being deleted. The value is a caption track ID as identified by the id property in a caption resource.

Onbehalfofcontentowner

The content owner's external ID on which behalf the user is acting on. Ifnnot set, the user is acting for himself (his own channel).

Onbehalfofcontentownerchannel

This parameter can only be used in a properly authorized request. Note: This parameter is intended exclusively for YouTube content partners.nnThe onBehalfOfContentOwnerChannel parameter specifies the YouTube channel ID of the channel to which a video is being added. This parameter is required when a request specifies a value for the onBehalfOfContentOwner parameter, and it can only be used in conjunction with that parameter. In addition, the request must be authorized using a CMS account that is

Part

The part parameter specifies a comma-separated list of one or more activity resource properties that the API response will include.nnIf the parameter identifies a property that contains child properties, the child properties will be included in the response. For example, in an activity resource, the snippet property contains other properties that identify the type of activity, a display title for the activity, and so forth. If you set part=snippet, the API response will also contain all of those

Streamid

The streamId parameter specifies the unique ID of the video stream that is being bound to a broadcast. If this parameter is omitted, the API will remove any existing binding between the broadcast and a video stream.

Response Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Displayslate

The displaySlate parameter specifies whether the slate is being enabled or disabled.

Id

The id parameter identifies the caption track that is being deleted. The value is a caption track ID as identified by the id property in a caption resource.

Offsettimems

The offsetTimeMs parameter specifies a positive time offset when the specified slate change will occur. The value is measured in milliseconds from the beginning of the broadcast's monitor stream, which is the time that the testing phase for the broadcast began. Even though it is specified in milliseconds, the value is actually an approximation, and YouTube completes the requested action as closely as possible to that time.nnIf you do not specify a value for this parameter, then YouTube performs

Onbehalfofcontentowner

The content owner's external ID on which behalf the user is acting on. Ifnnot set, the user is acting for himself (his own channel).

Onbehalfofcontentownerchannel

This parameter can only be used in a properly authorized request. Note: This parameter is intended exclusively for YouTube content partners.nnThe onBehalfOfContentOwnerChannel parameter specifies the YouTube channel ID of the channel to which a video is being added. This parameter is required when a request specifies a value for the onBehalfOfContentOwner parameter, and it can only be used in conjunction with that parameter. In addition, the request must be authorized using a CMS account that is

Part

The part parameter specifies a comma-separated list of one or more activity resource properties that the API response will include.nnIf the parameter identifies a property that contains child properties, the child properties will be included in the response. For example, in an activity resource, the snippet property contains other properties that identify the type of activity, a display title for the activity, and so forth. If you set part=snippet, the API response will also contain all of those

Walltime

The walltime parameter specifies the wall clock time at which the specified slate change will occur. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sssZ) format.

Response Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Broadcaststatus

The broadcastStatus parameter filters the API response to only include broadcasts with the specified status.

Id

The id parameter identifies the caption track that is being deleted. The value is a caption track ID as identified by the id property in a caption resource.

Onbehalfofcontentowner

The content owner's external ID on which behalf the user is acting on. Ifnnot set, the user is acting for himself (his own channel).

Onbehalfofcontentownerchannel

This parameter can only be used in a properly authorized request. Note: This parameter is intended exclusively for YouTube content partners.nnThe onBehalfOfContentOwnerChannel parameter specifies the YouTube channel ID of the channel to which a video is being added. This parameter is required when a request specifies a value for the onBehalfOfContentOwner parameter, and it can only be used in conjunction with that parameter. In addition, the request must be authorized using a CMS account that is

Part

The part parameter specifies a comma-separated list of one or more activity resource properties that the API response will include.nnIf the parameter identifies a property that contains child properties, the child properties will be included in the response. For example, in an activity resource, the snippet property contains other properties that identify the type of activity, a display title for the activity, and so forth. If you set part=snippet, the API response will also contain all of those

Response Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Id

The id parameter identifies the caption track that is being deleted. The value is a caption track ID as identified by the id property in a caption resource.

Onbehalfofcontentowner

The content owner's external ID on which behalf the user is acting on. Ifnnot set, the user is acting for himself (his own channel).

Onbehalfofcontentownerchannel

This parameter can only be used in a properly authorized request. Note: This parameter is intended exclusively for YouTube content partners.nnThe onBehalfOfContentOwnerChannel parameter specifies the YouTube channel ID of the channel to which a video is being added. This parameter is required when a request specifies a value for the onBehalfOfContentOwner parameter, and it can only be used in conjunction with that parameter. In addition, the request must be authorized using a CMS account that is

Response Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Id

The id parameter identifies the caption track that is being deleted. The value is a caption track ID as identified by the id property in a caption resource.

Response Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Id

The id parameter identifies the caption track that is being deleted. The value is a caption track ID as identified by the id property in a caption resource.

Response Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Id

The id parameter identifies the caption track that is being deleted. The value is a caption track ID as identified by the id property in a caption resource.

Response Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Channelid

The channelId parameter specifies a unique YouTube channel ID. The API will then return a list of that channel's activities.

Onbehalfofcontentowner

The content owner's external ID on which behalf the user is acting on. Ifnnot set, the user is acting for himself (his own channel).

Response Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Onbehalfofcontentowner

The content owner's external ID on which behalf the user is acting on. Ifnnot set, the user is acting for himself (his own channel).

Videoid

The videoId parameter specifies the YouTube video ID of the video for which the API should return caption tracks.

Response Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Id

The id parameter identifies the caption track that is being deleted. The value is a caption track ID as identified by the id property in a caption resource.

Onbehalfofcontentowner

The content owner's external ID on which behalf the user is acting on. Ifnnot set, the user is acting for himself (his own channel).

Response Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Id

The id parameter identifies the caption track that is being deleted. The value is a caption track ID as identified by the id property in a caption resource.

Onbehalfofcontentowner

The content owner's external ID on which behalf the user is acting on. Ifnnot set, the user is acting for himself (his own channel).

Response Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Id

The id parameter identifies the caption track that is being deleted. The value is a caption track ID as identified by the id property in a caption resource.

Onbehalfofcontentowner

The content owner's external ID on which behalf the user is acting on. Ifnnot set, the user is acting for himself (his own channel).

Response Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Id

The id parameter identifies the caption track that is being deleted. The value is a caption track ID as identified by the id property in a caption resource.

Onbehalfofcontentowner

The content owner's external ID on which behalf the user is acting on. Ifnnot set, the user is acting for himself (his own channel).

Onbehalfofcontentownerchannel

This parameter can only be used in a properly authorized request. Note: This parameter is intended exclusively for YouTube content partners.nnThe onBehalfOfContentOwnerChannel parameter specifies the YouTube channel ID of the channel to which a video is being added. This parameter is required when a request specifies a value for the onBehalfOfContentOwner parameter, and it can only be used in conjunction with that parameter. In addition, the request must be authorized using a CMS account that is

Response Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Id

The id parameter identifies the caption track that is being deleted. The value is a caption track ID as identified by the id property in a caption resource.

Onbehalfofcontentowner

The content owner's external ID on which behalf the user is acting on. Ifnnot set, the user is acting for himself (his own channel).

Response Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Id

The id parameter identifies the caption track that is being deleted. The value is a caption track ID as identified by the id property in a caption resource.

Onbehalfofcontentowner

The content owner's external ID on which behalf the user is acting on. Ifnnot set, the user is acting for himself (his own channel).

Response Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Id

The id parameter identifies the caption track that is being deleted. The value is a caption track ID as identified by the id property in a caption resource.

Response Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Channelid

The channelId parameter specifies a unique YouTube channel ID. The API will then return a list of that channel's activities.

Home

Set this parameter's value to true to retrieve the activity feed that displays on the YouTube home page for the currently authenticated user.

Maxresults

The maxResults parameter specifies the maximum number of items that should be returned in the result set.

Mine

Set this parameter's value to true to retrieve a feed of the authenticated user's activities.

Pagetoken

A token identifying a page of results the server should return. Typically,nthis is the value ofnListReportTypesResponse.next_page_tokennreturned in response to the previous call to the ListJobs method.

Part

The part parameter specifies a comma-separated list of one or more activity resource properties that the API response will include.nnIf the parameter identifies a property that contains child properties, the child properties will be included in the response. For example, in an activity resource, the snippet property contains other properties that identify the type of activity, a display title for the activity, and so forth. If you set part=snippet, the API response will also contain all of those

Publishedafter

The publishedAfter parameter specifies the earliest date and time that an activity could have occurred for that activity to be included in the API response. If the parameter value specifies a day, but not a time, then any activities that occurred that day will be included in the result set. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.

Publishedbefore

The publishedBefore parameter specifies the date and time before which an activity must have occurred for that activity to be included in the API response. If the parameter value specifies a day, but not a time, then any activities that occurred that day will be excluded from the result set. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.

Regioncode

The regionCode parameter instructs the API to return results for the specified country. The parameter value is an ISO 3166-1 alpha-2 country code. YouTube uses this value when the authorized user's previous activity on YouTube does not provide enough information to generate the activity feed.

Response Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Categoryid

The categoryId parameter specifies a YouTube guide category, thereby requesting YouTube channels associated with that category.

Forusername

The forUsername parameter specifies a YouTube username, thereby requesting the channel associated with that username.

Hl

The hl parameter indicates that the snippet.localized property values in the returned channelSection resources should be in the specified language if localized values for that language are available. For example, if the API request specifies hl=de, the snippet.localized properties in the API response will contain German titles if German titles are available. Channel owners can provide localized channel section titles using either the channelSections.insert or channelSections.update method.

Id

The id parameter identifies the caption track that is being deleted. The value is a caption track ID as identified by the id property in a caption resource.

Managedbyme

Note: This parameter is intended exclusively for YouTube content partners.nnSet this parameter's value to true to instruct the API to only return channels managed by the content owner that the onBehalfOfContentOwner parameter specifies. The user must be authenticated as a CMS account linked to the specified content owner and onBehalfOfContentOwner must be provided.

Maxresults

The maxResults parameter specifies the maximum number of items that should be returned in the result set.

Mine

Set this parameter's value to true to retrieve a feed of the authenticated user's activities.

Mysubscribers

Use the subscriptions.list method and its mySubscribers parameter to retrieve a list of subscribers to the authenticated user's channel.

Onbehalfofcontentowner

The content owner's external ID on which behalf the user is acting on. Ifnnot set, the user is acting for himself (his own channel).

Pagetoken

A token identifying a page of results the server should return. Typically,nthis is the value ofnListReportTypesResponse.next_page_tokennreturned in response to the previous call to the ListJobs method.

Part

The part parameter specifies a comma-separated list of one or more activity resource properties that the API response will include.nnIf the parameter identifies a property that contains child properties, the child properties will be included in the response. For example, in an activity resource, the snippet property contains other properties that identify the type of activity, a display title for the activity, and so forth. If you set part=snippet, the API response will also contain all of those

Response Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Allthreadsrelatedtochannelid

The allThreadsRelatedToChannelId parameter instructs the API to return all comment threads associated with the specified channel. The response can include comments about the channel or about the channel's videos.

Channelid

The channelId parameter specifies a unique YouTube channel ID. The API will then return a list of that channel's activities.

Id

The id parameter identifies the caption track that is being deleted. The value is a caption track ID as identified by the id property in a caption resource.

Maxresults

The maxResults parameter specifies the maximum number of items that should be returned in the result set.

Moderationstatus

Set this parameter to limit the returned comment threads to a particular moderation state.nnNote: This parameter is not supported for use in conjunction with the id parameter.

Order

The order parameter specifies the order in which the API response should list comment threads. Valid values are: n- time - Comment threads are ordered by time. This is the default behavior.n- relevance - Comment threads are ordered by relevance.Note: This parameter is not supported for use in conjunction with the id parameter.

Pagetoken

A token identifying a page of results the server should return. Typically,nthis is the value ofnListReportTypesResponse.next_page_tokennreturned in response to the previous call to the ListJobs method.

Part

The part parameter specifies a comma-separated list of one or more activity resource properties that the API response will include.nnIf the parameter identifies a property that contains child properties, the child properties will be included in the response. For example, in an activity resource, the snippet property contains other properties that identify the type of activity, a display title for the activity, and so forth. If you set part=snippet, the API response will also contain all of those

Searchterms

The searchTerms parameter instructs the API to limit the API response to only contain comments that contain the specified search terms.nnNote: This parameter is not supported for use in conjunction with the id parameter.

Textformat

Set this parameter's value to html or plainText to instruct the API to return the comments left by users in html formatted or in plain text.

Videoid

The videoId parameter specifies the YouTube video ID of the video for which the API should return caption tracks.

Response Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Hl

The hl parameter indicates that the snippet.localized property values in the returned channelSection resources should be in the specified language if localized values for that language are available. For example, if the API request specifies hl=de, the snippet.localized properties in the API response will contain German titles if German titles are available. Channel owners can provide localized channel section titles using either the channelSections.insert or channelSections.update method.

Maxresults

The maxResults parameter specifies the maximum number of items that should be returned in the result set.

Pagetoken

A token identifying a page of results the server should return. Typically,nthis is the value ofnListReportTypesResponse.next_page_tokennreturned in response to the previous call to the ListJobs method.

Part

The part parameter specifies a comma-separated list of one or more activity resource properties that the API response will include.nnIf the parameter identifies a property that contains child properties, the child properties will be included in the response. For example, in an activity resource, the snippet property contains other properties that identify the type of activity, a display title for the activity, and so forth. If you set part=snippet, the API response will also contain all of those

Response Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Hl

The hl parameter indicates that the snippet.localized property values in the returned channelSection resources should be in the specified language if localized values for that language are available. For example, if the API request specifies hl=de, the snippet.localized properties in the API response will contain German titles if German titles are available. Channel owners can provide localized channel section titles using either the channelSections.insert or channelSections.update method.

Id

The id parameter identifies the caption track that is being deleted. The value is a caption track ID as identified by the id property in a caption resource.

Part

The part parameter specifies a comma-separated list of one or more activity resource properties that the API response will include.nnIf the parameter identifies a property that contains child properties, the child properties will be included in the response. For example, in an activity resource, the snippet property contains other properties that identify the type of activity, a display title for the activity, and so forth. If you set part=snippet, the API response will also contain all of those

Regioncode

The regionCode parameter instructs the API to return results for the specified country. The parameter value is an ISO 3166-1 alpha-2 country code. YouTube uses this value when the authorized user's previous activity on YouTube does not provide enough information to generate the activity feed.

Response Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Hl

The hl parameter indicates that the snippet.localized property values in the returned channelSection resources should be in the specified language if localized values for that language are available. For example, if the API request specifies hl=de, the snippet.localized properties in the API response will contain German titles if German titles are available. Channel owners can provide localized channel section titles using either the channelSections.insert or channelSections.update method.

Part

The part parameter specifies a comma-separated list of one or more activity resource properties that the API response will include.nnIf the parameter identifies a property that contains child properties, the child properties will be included in the response. For example, in an activity resource, the snippet property contains other properties that identify the type of activity, a display title for the activity, and so forth. If you set part=snippet, the API response will also contain all of those

Response Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Hl

The hl parameter indicates that the snippet.localized property values in the returned channelSection resources should be in the specified language if localized values for that language are available. For example, if the API request specifies hl=de, the snippet.localized properties in the API response will contain German titles if German titles are available. Channel owners can provide localized channel section titles using either the channelSections.insert or channelSections.update method.

Part

The part parameter specifies a comma-separated list of one or more activity resource properties that the API response will include.nnIf the parameter identifies a property that contains child properties, the child properties will be included in the response. For example, in an activity resource, the snippet property contains other properties that identify the type of activity, a display title for the activity, and so forth. If you set part=snippet, the API response will also contain all of those

Response Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Currency

The currency to which financial metrics should be converted. The default is US Dollar (USD). If the result contains no financial metrics, this flag will be ignored. Responds with an error if the specified currency is not recognized.

Dimensions

A comma-separated list of YouTube Analytics dimensions, such as views or ageGroup,gender. See the Available Reports document for a list of the reports that you can retrieve and the dimensions used for those reports. Also see the Dimensions document for definitions of those dimensions.

End

The end date for fetching YouTube Analytics data. The value should be in YYYY-MM-DD format.

Filters

A list of filters that should be applied when retrieving YouTube Analytics data. The Available Reports document identifies the dimensions that can be used to filter each report, and the Dimensions document defines those dimensions. If a request uses multiple filters, join them together with a semicolon (;), and the returned result table will satisfy both filters. For example, a filters parameter value of video==dMH0bHeiRNg;country==IT restricts the result set to include data for the given video

Ids

Identifies the YouTube channel or content owner for which you are retrieving YouTube Analytics data.n- To request data for a YouTube user, set the ids parameter value to channel==CHANNEL_ID, where CHANNEL_ID specifies the unique YouTube channel ID.n- To request data for a YouTube CMS content owner, set the ids parameter value to contentOwner==OWNER_NAME, where OWNER_NAME is the CMS name of the content owner.

Include

If set to true historical data (i.e. channel data from before the linking of the channel to the content owner) will be retrieved.

Max

The maximum number of rows to include in the response.

Metrics

A comma-separated list of YouTube Analytics metrics, such as views or likes,dislikes. See the Available Reports document for a list of the reports that you can retrieve and the metrics available in each report, and see the Metrics document for definitions of those metrics.

Sort

A comma-separated list of dimensions or metrics that determine the sort order for YouTube Analytics data. By default the sort order is ascending. The '-' prefix causes descending sort order.

Start

The start date for fetching YouTube Analytics data. The value should be in YYYY-MM-DD format.

Response Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Channelid

The channelId parameter specifies a unique YouTube channel ID. The API will then return a list of that channel's activities.

Channeltype

The channelType parameter lets you restrict a search to a particular type of channel.

Eventtype

The eventType parameter restricts a search to broadcast events. If you specify a value for this parameter, you must also set the type parameter's value to video.

Forcontentowner

Note: This parameter is intended exclusively for YouTube content partners.nnThe forContentOwner parameter restricts the search to only retrieve resources owned by the content owner specified by the onBehalfOfContentOwner parameter. The user must be authenticated using a CMS account linked to the specified content owner and onBehalfOfContentOwner must be provided.

Fordeveloper

The forDeveloper parameter restricts the search to only retrieve videos uploaded via the developer's application or website. The API server uses the request's authorization credentials to identify the developer. Therefore, a developer can restrict results to videos uploaded through the developer's own app or website but not to videos uploaded through other apps or sites.

Formine

The forMine parameter restricts the search to only retrieve videos owned by the authenticated user. If you set this parameter to true, then the type parameter's value must also be set to video.

Location

The location parameter, in conjunction with the locationRadius parameter, defines a circular geographic area and also restricts a search to videos that specify, in their metadata, a geographic location that falls within that area. The parameter value is a string that specifies latitude/longitude coordinates e.g. (37.42307,-122.08427).nnn- The location parameter value identifies the point at the center of the area.n- The locationRadius parameter specifies the maximum distance that the location as

Locationradius

The locationRadius parameter, in conjunction with the location parameter, defines a circular geographic area.nnThe parameter value must be a floating point number followed by a measurement unit. Valid measurement units are m, km, ft, and mi. For example, valid parameter values include 1500m, 5km, 10000ft, and 0.75mi. The API does not support locationRadius parameter values larger than 1000 kilometers.nnNote: See the definition of the location parameter for more information.

Maxresults

The maxResults parameter specifies the maximum number of items that should be returned in the result set.

Onbehalfofcontentowner

The content owner's external ID on which behalf the user is acting on. Ifnnot set, the user is acting for himself (his own channel).

Order

The order parameter specifies the order in which the API response should list comment threads. Valid values are: n- time - Comment threads are ordered by time. This is the default behavior.n- relevance - Comment threads are ordered by relevance.Note: This parameter is not supported for use in conjunction with the id parameter.

Pagetoken

A token identifying a page of results the server should return. Typically,nthis is the value ofnListReportTypesResponse.next_page_tokennreturned in response to the previous call to the ListJobs method.

Part

The part parameter specifies a comma-separated list of one or more activity resource properties that the API response will include.nnIf the parameter identifies a property that contains child properties, the child properties will be included in the response. For example, in an activity resource, the snippet property contains other properties that identify the type of activity, a display title for the activity, and so forth. If you set part=snippet, the API response will also contain all of those

Publishedafter

The publishedAfter parameter specifies the earliest date and time that an activity could have occurred for that activity to be included in the API response. If the parameter value specifies a day, but not a time, then any activities that occurred that day will be included in the result set. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.

Publishedbefore

The publishedBefore parameter specifies the date and time before which an activity must have occurred for that activity to be included in the API response. If the parameter value specifies a day, but not a time, then any activities that occurred that day will be excluded from the result set. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format.

Q

The q parameter specifies the query term to search for.nnYour request can also use the Boolean NOT (-) and OR (|) operators to exclude videos or to find videos that are associated with one of several search terms. For example, to search for videos matching either boating or sailing, set the q parameter value to boating|sailing. Similarly, to search for videos matching either boating or sailing but not fishing, set the q parameter value to boating|sailing -fishing. Note that the pipe ch

Regioncode

The regionCode parameter instructs the API to return results for the specified country. The parameter value is an ISO 3166-1 alpha-2 country code. YouTube uses this value when the authorized user's previous activity on YouTube does not provide enough information to generate the activity feed.

Relatedtovideoid

The relatedToVideoId parameter retrieves a list of videos that are related to the video that the parameter value identifies. The parameter value must be set to a YouTube video ID and, if you are using this parameter, the type parameter must be set to video.

Relevancelanguage

The relevanceLanguage parameter instructs the API to return search results that are most relevant to the specified language. The parameter value is typically an ISO 639-1 two-letter language code. However, you should use the values zh-Hans for simplified Chinese and zh-Hant for traditional Chinese. Please note that results in other languages will still be returned if they are highly relevant to the search query term.

Safesearch

The safeSearch parameter indicates whether the search results should include restricted content as well as standard content.

Topicid

The topicId parameter indicates that the API response should only contain resources associated with the specified topic. The value identifies a Freebase topic ID.

Type

The type parameter restricts a search query to only retrieve a particular type of resource. The value is a comma-separated list of resource types.

Videocaption

The videoCaption parameter indicates whether the API should filter video search results based on whether they have captions. If you specify a value for this parameter, you must also set the type parameter's value to video.

Videocategoryid

The videoCategoryId parameter filters video search results based on their category. If you specify a value for this parameter, you must also set the type parameter's value to video.

Videodefinition

The videoDefinition parameter lets you restrict a search to only include either high definition (HD) or standard definition (SD) videos. HD videos are available for playback in at least 720p, though higher resolutions, like 1080p, might also be available. If you specify a value for this parameter, you must also set the type parameter's value to video.

Videodimension

The videoDimension parameter lets you restrict a search to only retrieve 2D or 3D videos. If you specify a value for this parameter, you must also set the type parameter's value to video.

Videoduration

The videoDuration parameter filters video search results based on their duration. If you specify a value for this parameter, you must also set the type parameter's value to video.

Videoembeddable

The videoEmbeddable parameter lets you to restrict a search to only videos that can be embedded into a webpage. If you specify a value for this parameter, you must also set the type parameter's value to video.

Videolicense

The videoLicense parameter filters search results to only include videos with a particular license. YouTube lets video uploaders choose to attach either the Creative Commons license or the standard YouTube license to each of their videos. If you specify a value for this parameter, you must also set the type parameter's value to video.

Videosyndicated

The videoSyndicated parameter lets you to restrict a search to only videos that can be played outside youtube.com. If you specify a value for this parameter, you must also set the type parameter's value to video.

Videotype

The videoType parameter lets you restrict a search to a particular type of videos. If you specify a value for this parameter, you must also set the type parameter's value to video.

Response Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Filter

The filter parameter specifies which channel sponsors to return.

Maxresults

The maxResults parameter specifies the maximum number of items that should be returned in the result set.

Pagetoken

A token identifying a page of results the server should return. Typically,nthis is the value ofnListReportTypesResponse.next_page_tokennreturned in response to the previous call to the ListJobs method.

Part

The part parameter specifies a comma-separated list of one or more activity resource properties that the API response will include.nnIf the parameter identifies a property that contains child properties, the child properties will be included in the response. For example, in an activity resource, the snippet property contains other properties that identify the type of activity, a display title for the activity, and so forth. If you set part=snippet, the API response will also contain all of those

Response Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Hl

The hl parameter indicates that the snippet.localized property values in the returned channelSection resources should be in the specified language if localized values for that language are available. For example, if the API request specifies hl=de, the snippet.localized properties in the API response will contain German titles if German titles are available. Channel owners can provide localized channel section titles using either the channelSections.insert or channelSections.update method.

Maxresults

The maxResults parameter specifies the maximum number of items that should be returned in the result set.

Pagetoken

A token identifying a page of results the server should return. Typically,nthis is the value ofnListReportTypesResponse.next_page_tokennreturned in response to the previous call to the ListJobs method.

Part

The part parameter specifies a comma-separated list of one or more activity resource properties that the API response will include.nnIf the parameter identifies a property that contains child properties, the child properties will be included in the response. For example, in an activity resource, the snippet property contains other properties that identify the type of activity, a display title for the activity, and so forth. If you set part=snippet, the API response will also contain all of those

Response Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Hl

The hl parameter indicates that the snippet.localized property values in the returned channelSection resources should be in the specified language if localized values for that language are available. For example, if the API request specifies hl=de, the snippet.localized properties in the API response will contain German titles if German titles are available. Channel owners can provide localized channel section titles using either the channelSections.insert or channelSections.update method.

Id

The id parameter identifies the caption track that is being deleted. The value is a caption track ID as identified by the id property in a caption resource.

Part

The part parameter specifies a comma-separated list of one or more activity resource properties that the API response will include.nnIf the parameter identifies a property that contains child properties, the child properties will be included in the response. For example, in an activity resource, the snippet property contains other properties that identify the type of activity, a display title for the activity, and so forth. If you set part=snippet, the API response will also contain all of those

Regioncode

The regionCode parameter instructs the API to return results for the specified country. The parameter value is an ISO 3166-1 alpha-2 country code. YouTube uses this value when the authorized user's previous activity on YouTube does not provide enough information to generate the activity feed.

Response Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Hl

The hl parameter indicates that the snippet.localized property values in the returned channelSection resources should be in the specified language if localized values for that language are available. For example, if the API request specifies hl=de, the snippet.localized properties in the API response will contain German titles if German titles are available. Channel owners can provide localized channel section titles using either the channelSections.insert or channelSections.update method.

Part

The part parameter specifies a comma-separated list of one or more activity resource properties that the API response will include.nnIf the parameter identifies a property that contains child properties, the child properties will be included in the response. For example, in an activity resource, the snippet property contains other properties that identify the type of activity, a display title for the activity, and so forth. If you set part=snippet, the API response will also contain all of those

Response Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Resourcename

Name of the media that is being downloaded.

Response Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Includesystemmanaged

If set to true, also system-managed jobs will be returned; otherwise onlynuser-created jobs will be returned. System-managed jobs can neither benmodified nor deleted.

Onbehalfofcontentowner

The content owner's external ID on which behalf the user is acting on. Ifnnot set, the user is acting for himself (his own channel).

Pagesize

Requested page size. Server may return fewer jobs than requested.nIf unspecified, server will pick an appropriate default.

Pagetoken

A token identifying a page of results the server should return. Typically,nthis is the value ofnListReportTypesResponse.next_page_tokennreturned in response to the previous call to the ListJobs method.

Response Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Id

The id parameter identifies the caption track that is being deleted. The value is a caption track ID as identified by the id property in a caption resource.

Rating

Specifies the rating to record.

Response Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Onbehalfofcontentowner

The content owner's external ID on which behalf the user is acting on. Ifnnot set, the user is acting for himself (his own channel).

Response Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Id

The id parameter identifies the caption track that is being deleted. The value is a caption track ID as identified by the id property in a caption resource.

Onbehalfofcontentowner

The content owner's external ID on which behalf the user is acting on. Ifnnot set, the user is acting for himself (his own channel).

Response Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Id

The id parameter identifies the caption track that is being deleted. The value is a caption track ID as identified by the id property in a caption resource.

Onbehalfofcontentowner

The content owner's external ID on which behalf the user is acting on. Ifnnot set, the user is acting for himself (his own channel).

Response Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Channelid

The channelId parameter specifies a unique YouTube channel ID. The API will then return a list of that channel's activities.

Onbehalfofcontentowner

The content owner's external ID on which behalf the user is acting on. Ifnnot set, the user is acting for himself (his own channel).

Response Type

N/A

headers

N/A

headers.Header Key

N/A

headers.Header Value

N/A

Channelid

The channelId parameter specifies a unique YouTube channel ID. The API will then return a list of that channel's activities.

Onbehalfofcontentowner

The content owner's external ID on which behalf the user is acting on. Ifnnot set, the user is acting for himself (his own channel).

Response Type

N/A