#include <you_tube_service.h>
Implements the update 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/youtubepartner
◆ ChannelsResource_UpdateMethod()
google_youtube_api::ChannelsResource_UpdateMethod::ChannelsResource_UpdateMethod |
( |
const YouTubeService * |
_service_, |
|
|
client::AuthorizationCredential * |
_credential_, |
|
|
const absl::string_view & |
part, |
|
|
const Channel & |
_content_ |
|
) |
| |
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. |
The API currently only allows the parameter value to be set to either brandingSettings or invideoPromotion. (You cannot update both of those parts with a single request.)
Note that this method overrides the existing values for all of the mutable properties that are contained in any parts that the parameter value specifies.
- Parameters
-
[in] | <em>content</em> | The data object to update. |
◆ ~ChannelsResource_UpdateMethod()
google_youtube_api::ChannelsResource_UpdateMethod::~ChannelsResource_UpdateMethod |
( |
| ) |
|
|
virtual |
◆ AppendOptionalQueryParameters()
util::Status google_youtube_api::ChannelsResource_UpdateMethod::AppendOptionalQueryParameters |
( |
string * |
target | ) |
|
|
virtual |
◆ AppendVariable()
util::Status google_youtube_api::ChannelsResource_UpdateMethod::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_on_behalf_of_content_owner()
void google_youtube_api::ChannelsResource_UpdateMethod::clear_on_behalf_of_content_owner |
( |
| ) |
|
|
inline |
Clears the 'onBehalfOfContentOwner
' attribute so it is no longer set.
◆ ExecuteAndParseResponse()
util::Status google_youtube_api::ChannelsResource_UpdateMethod::ExecuteAndParseResponse |
( |
Channel * |
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_on_behalf_of_content_owner()
const string& google_youtube_api::ChannelsResource_UpdateMethod::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.
◆ mutable_onBehalfOfContentOwner()
string* google_youtube_api::ChannelsResource_UpdateMethod::mutable_onBehalfOfContentOwner |
( |
| ) |
|
|
inline |
Gets a modifiable pointer to the optional onBehalfOfContentOwner
' attribute.
- Returns
- The value can be set by dereferencing the pointer.
◆ set_on_behalf_of_content_owner()
void google_youtube_api::ChannelsResource_UpdateMethod::set_on_behalf_of_content_owner |
( |
const string & |
value | ) |
|
|
inline |
Sets the 'onBehalfOfContentOwner
' attribute.
- Parameters
-
[in] | value | The onBehalfOfContentOwner parameter indicates that the authenticated user 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 actual CMS account that the user authenticates with needs to be linked to the specified YouTube content owner. |
The documentation for this class was generated from the following files: