#include <you_tube_service.h>
|
| VideosResource_InsertMethod (const YouTubeService *_service_, client::AuthorizationCredential *_credential_, const absl::string_view &part) |
|
| VideosResource_InsertMethod (const YouTubeService *_service_, client::AuthorizationCredential *_credential_, const absl::string_view &part, const Video *_metadata_, const StringPiece &_media_content_type_, client::DataReader *_media_content_reader_) |
|
virtual | ~VideosResource_InsertMethod () |
|
void | clear_auto_levels () |
|
bool | get_auto_levels () const |
|
void | set_auto_levels (bool value) |
|
void | clear_notify_subscribers () |
|
bool | get_notify_subscribers () const |
|
void | set_notify_subscribers (bool value) |
|
void | clear_on_behalf_of_content_owner () |
|
const string & | get_on_behalf_of_content_owner () const |
|
string * | mutable_onBehalfOfContentOwner () |
|
void | set_on_behalf_of_content_owner (const string &value) |
|
void | clear_on_behalf_of_content_owner_channel () |
|
const string & | get_on_behalf_of_content_owner_channel () const |
|
string * | mutable_onBehalfOfContentOwnerChannel () |
|
void | set_on_behalf_of_content_owner_channel (const string &value) |
|
void | clear_stabilize () |
|
bool | get_stabilize () const |
|
void | set_stabilize (bool value) |
|
virtual util::Status | AppendVariable (const StringPiece &variable_name, const client::UriTemplateConfig &config, string *target) |
|
virtual util::Status | AppendOptionalQueryParameters (string *target) |
|
util::Status | ExecuteAndParseResponse (Video *data) |
|
| YouTubeServiceBaseRequest (const client::ClientService *service, client::AuthorizationCredential *credential, client::HttpRequest::HttpMethod method, const StringPiece &uri_template) |
|
virtual | ~YouTubeServiceBaseRequest () |
|
void | clear_alt () |
|
const string & | get_alt () const |
|
string * | mutable_alt () |
|
void | set_alt (const string &value) |
|
void | clear_fields () |
|
const string & | get_fields () const |
|
string * | mutable_fields () |
|
void | set_fields (const string &value) |
|
void | clear_key () |
|
const string & | get_key () const |
|
string * | mutable_key () |
|
void | set_key (const string &value) |
|
void | clear_oauth_token () |
|
const string & | get_oauth_token () const |
|
string * | mutable_oauthToken () |
|
void | set_oauth_token (const string &value) |
|
void | clear_pretty_print () |
|
bool | get_pretty_print () const |
|
void | set_pretty_print (bool value) |
|
void | clear_quota_user () |
|
const string & | get_quota_user () const |
|
string * | mutable_quotaUser () |
|
void | set_quota_user (const string &value) |
|
void | clear_user_ip () |
|
const string & | get_user_ip () const |
|
string * | mutable_userIp () |
|
void | set_user_ip (const string &value) |
|
Implements the insert method.
This class uses the Command Pattern. Construct an instance with the required parameters, then set any additional optional parameters by using the attribute setters. To invoke the method, call Execute
.
One or more of these authorization scopes are required for this method: https://www.googleapis.com/auth/youtube https://www.googleapis.com/auth/youtube.force-ssl https://www.googleapis.com/auth/youtube.upload https://www.googleapis.com/auth/youtubepartner
◆ VideosResource_InsertMethod() [1/2]
google_youtube_api::VideosResource_InsertMethod::VideosResource_InsertMethod |
( |
const YouTubeService * |
_service_, |
|
|
client::AuthorizationCredential * |
_credential_, |
|
|
const absl::string_view & |
part |
|
) |
| |
The standard constructor takes all the required method parameters.
- Deprecated:
- in favor constructor that includes the media upload parameters.
- Parameters
-
[in] | <em>service</em> | The service instance to send to when executed. |
[in] | <em>credential</em> | If not NULL, the credential to authorize with. In practice this is supplied by the user code that is creating the method instance. |
[in] | part | The part parameter serves two purposes in this operation. It identifies the properties that the write operation will set as well as the properties that the API response will include. |
Note that not all parts contain properties that can be set when inserting or updating a video. For example, the statistics object encapsulates statistics that YouTube calculates for a video and does not contain values that you can set or modify. If the parameter value specifies a part that does not contain mutable values, that part will still be included in the API response.
- Parameters
-
[in] | <em>content</em> | The data object to insert. |
◆ VideosResource_InsertMethod() [2/2]
google_youtube_api::VideosResource_InsertMethod::VideosResource_InsertMethod |
( |
const YouTubeService * |
_service_, |
|
|
client::AuthorizationCredential * |
_credential_, |
|
|
const absl::string_view & |
part, |
|
|
const Video * |
_metadata_, |
|
|
const StringPiece & |
_media_content_type_, |
|
|
client::DataReader * |
_media_content_reader_ |
|
) |
| |
The standard constructor takes all the required method parameters.
- Parameters
-
[in] | <em>service</em> | The service instance to send to when executed. |
[in] | <em>credential</em> | If not NULL, the credential to authorize with. In practice this is supplied by the user code that is creating the method instance. |
[in] | part | The part parameter serves two purposes in this operation. It identifies the properties that the write operation will set as well as the properties that the API response will include. |
Note that not all parts contain properties that can be set when inserting or updating a video. For example, the statistics object encapsulates statistics that YouTube calculates for a video and does not contain values that you can set or modify. If the parameter value specifies a part that does not contain mutable values, that part will still be included in the API response.
- Parameters
-
[in] | <em>metadata</em> | The metadata object to insert. If this is NULL then do not upload any metadata. |
[in] | <em>media_content_type</em> | The content type of the data in the media_content_reader. |
[in] | <em>media_content_reader</em> | The media content to insert. If this is NULL then do not upload any media and ignore media_content_type. |
◆ ~VideosResource_InsertMethod()
google_youtube_api::VideosResource_InsertMethod::~VideosResource_InsertMethod |
( |
| ) |
|
|
virtual |
◆ AppendOptionalQueryParameters()
util::Status google_youtube_api::VideosResource_InsertMethod::AppendOptionalQueryParameters |
( |
string * |
target | ) |
|
|
virtual |
◆ AppendVariable()
util::Status google_youtube_api::VideosResource_InsertMethod::AppendVariable |
( |
const StringPiece & |
variable_name, |
|
|
const client::UriTemplateConfig & |
config, |
|
|
string * |
target |
|
) |
| |
|
virtual |
Appends variable value to the target string.
This is a helper function used to resolve templated variables in the URI.
- Parameters
-
[in] | variable_name | The name of the templated variable. |
[in] | config | A pass-through parameter used for lists and maps. |
[in,out] | target | The string to append the value to. |
Reimplemented from google_youtube_api::YouTubeServiceBaseRequest.
◆ clear_auto_levels()
void google_youtube_api::VideosResource_InsertMethod::clear_auto_levels |
( |
| ) |
|
|
inline |
Clears the 'autoLevels
' attribute so it is no longer set.
◆ clear_notify_subscribers()
void google_youtube_api::VideosResource_InsertMethod::clear_notify_subscribers |
( |
| ) |
|
|
inline |
Clears the 'notifySubscribers
' attribute so it is no longer set.
◆ clear_on_behalf_of_content_owner()
void google_youtube_api::VideosResource_InsertMethod::clear_on_behalf_of_content_owner |
( |
| ) |
|
|
inline |
Clears the 'onBehalfOfContentOwner
' attribute so it is no longer set.
◆ clear_on_behalf_of_content_owner_channel()
void google_youtube_api::VideosResource_InsertMethod::clear_on_behalf_of_content_owner_channel |
( |
| ) |
|
|
inline |
Clears the 'onBehalfOfContentOwnerChannel
' attribute so it is no longer set.
◆ clear_stabilize()
void google_youtube_api::VideosResource_InsertMethod::clear_stabilize |
( |
| ) |
|
|
inline |
Clears the 'stabilize
' attribute so it is no longer set.
◆ ExecuteAndParseResponse()
util::Status google_youtube_api::VideosResource_InsertMethod::ExecuteAndParseResponse |
( |
Video * |
data | ) |
|
|
inline |
Executes the method and parses the response into a data object on success.
- Parameters
-
[out] | data | Loads from the response payload JSON data on success. |
- Returns
- Success if an HTTP 2xx response was received. Otherwise the status indicates the reason for failure. Finer detail may be available from the underlying http_request to distinguish the transport_status from the overal HTTP request status.
◆ get_auto_levels()
bool google_youtube_api::VideosResource_InsertMethod::get_auto_levels |
( |
| ) |
const |
|
inline |
Gets the optional 'autoLevels
' attribute.
If the value is not set then the default value will be returned.
◆ get_notify_subscribers()
bool google_youtube_api::VideosResource_InsertMethod::get_notify_subscribers |
( |
| ) |
const |
|
inline |
Gets the optional 'notifySubscribers
' attribute.
If the value is not set then the default value will be returned.
◆ get_on_behalf_of_content_owner()
const string& google_youtube_api::VideosResource_InsertMethod::get_on_behalf_of_content_owner |
( |
| ) |
const |
|
inline |
Gets the optional 'onBehalfOfContentOwner
' attribute.
If the value is not set then the default value will be returned.
◆ get_on_behalf_of_content_owner_channel()
const string& google_youtube_api::VideosResource_InsertMethod::get_on_behalf_of_content_owner_channel |
( |
| ) |
const |
|
inline |
Gets the optional 'onBehalfOfContentOwnerChannel
' attribute.
If the value is not set then the default value will be returned.
◆ get_stabilize()
bool google_youtube_api::VideosResource_InsertMethod::get_stabilize |
( |
| ) |
const |
|
inline |
Gets the optional 'stabilize
' attribute.
If the value is not set then the default value will be returned.
◆ mutable_onBehalfOfContentOwner()
string* google_youtube_api::VideosResource_InsertMethod::mutable_onBehalfOfContentOwner |
( |
| ) |
|
|
inline |
Gets a modifiable pointer to the optional onBehalfOfContentOwner
' attribute.
- Returns
- The value can be set by dereferencing the pointer.
◆ mutable_onBehalfOfContentOwnerChannel()
string* google_youtube_api::VideosResource_InsertMethod::mutable_onBehalfOfContentOwnerChannel |
( |
| ) |
|
|
inline |
Gets a modifiable pointer to the optional onBehalfOfContentOwnerChannel
' attribute.
- Returns
- The value can be set by dereferencing the pointer.
◆ set_auto_levels()
void google_youtube_api::VideosResource_InsertMethod::set_auto_levels |
( |
bool |
value | ) |
|
|
inline |
Sets the 'autoLevels
' attribute.
- Parameters
-
[in] | value | The autoLevels parameter indicates whether YouTube should automatically enhance the video's lighting and color. |
◆ set_notify_subscribers()
void google_youtube_api::VideosResource_InsertMethod::set_notify_subscribers |
( |
bool |
value | ) |
|
|
inline |
Sets the 'notifySubscribers
' attribute.
- Parameters
-
[in] | value | The notifySubscribers parameter indicates whether YouTube should send a notification about the new video to users who subscribe to the video's channel. A parameter value of True indicates that subscribers will be notified of newly uploaded videos. However, a channel owner who is uploading many videos might prefer to set the value to False to avoid sending a notification about each new video to the channel's subscribers. |
◆ set_on_behalf_of_content_owner()
void google_youtube_api::VideosResource_InsertMethod::set_on_behalf_of_content_owner |
( |
const string & |
value | ) |
|
|
inline |
Sets the 'onBehalfOfContentOwner
' attribute.
- Parameters
-
[in] | value | Note: This parameter is intended exclusively for YouTube content partners. |
The onBehalfOfContentOwner parameter indicates that the request's authorization credentials identify a YouTube CMS user who is acting on behalf of the content owner specified in the parameter value. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and get access to all their video and channel data, without having to provide authentication credentials for each individual channel. The CMS account that the user authenticates with must be linked to the specified YouTube content owner.
◆ set_on_behalf_of_content_owner_channel()
void google_youtube_api::VideosResource_InsertMethod::set_on_behalf_of_content_owner_channel |
( |
const string & |
value | ) |
|
|
inline |
Sets the 'onBehalfOfContentOwnerChannel
' attribute.
- Parameters
-
[in] | value | This parameter can only be used in a properly authorized request. Note: This parameter is intended exclusively for YouTube content partners. |
The 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 linked to the content owner that the onBehalfOfContentOwner parameter specifies. Finally, the channel that the onBehalfOfContentOwnerChannel parameter value specifies must be linked to the content owner that the onBehalfOfContentOwner parameter specifies.
This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and perform actions on behalf of the channel specified in the parameter value, without having to provide authentication credentials for each separate channel.
◆ set_stabilize()
void google_youtube_api::VideosResource_InsertMethod::set_stabilize |
( |
bool |
value | ) |
|
|
inline |
Sets the 'stabilize
' attribute.
- Parameters
-
[in] | value | The stabilize parameter indicates whether YouTube should adjust the video to remove shaky camera motions. |
◆ RESUMABLE_MEDIA_UPLOAD
const client::MediaUploadSpec google_youtube_api::VideosResource_InsertMethod::RESUMABLE_MEDIA_UPLOAD |
|
static |
Returns the specification for media upload using the resumable protocol.
◆ SIMPLE_MEDIA_UPLOAD
const client::MediaUploadSpec google_youtube_api::VideosResource_InsertMethod::SIMPLE_MEDIA_UPLOAD |
|
static |
Returns MediaUploader for uploading the content. Returns the specification for media upload using the simple protocol.
The documentation for this class was generated from the following files: