google_youtube_api::VideosResource_GetRatingMethod Class Reference

#include <you_tube_service.h>

Inheritance diagram for google_youtube_api::VideosResource_GetRatingMethod:

Public Member Functions
	VideosResource_GetRatingMethod (const YouTubeService *_service_, client::AuthorizationCredential *_credential_, const absl::string_view &id)
virtual	~VideosResource_GetRatingMethod ()
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)
virtual util::Status	AppendVariable (const StringPiece &variable_name, const client::UriTemplateConfig &config, string *target)
virtual util::Status	AppendOptionalQueryParameters (string *target)
util::Status	ExecuteAndParseResponse (VideoGetRatingResponse *data)
Public Member Functions inherited from google_youtube_api::YouTubeServiceBaseRequest
	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)

Additional Inherited Members
Protected Member Functions inherited from google_youtube_api::YouTubeServiceBaseRequest
void	AddJsonContentToRequest (const client::JsonCppData *content)

Detailed Description

Implements the getRating 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

Constructor & Destructor Documentation

VideosResource_GetRatingMethod()

google_youtube_api::VideosResource_GetRatingMethod::VideosResource_GetRatingMethod	(	const YouTubeService *	_service_,
		client::AuthorizationCredential *	_credential_,
		const absl::string_view &	id
	)

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]	id	The id parameter specifies a comma-separated list of the YouTube video ID(s) for the resource(s) for which you are retrieving rating data. In a video resource, the id property specifies the video's ID.

~VideosResource_GetRatingMethod()

google_youtube_api::VideosResource_GetRatingMethod::~VideosResource_GetRatingMethod ( )

virtual

Standard destructor.

Member Function Documentation

AppendOptionalQueryParameters()

util::Status google_youtube_api::VideosResource_GetRatingMethod::AppendOptionalQueryParameters ( string *  target )

virtual

Appends the optional query parameters to the target URL.

Parameters

[in,out]

target

The URL string to append to.

Reimplemented from google_youtube_api::YouTubeServiceBaseRequest.

AppendVariable()

util::Status google_youtube_api::VideosResource_GetRatingMethod::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::VideosResource_GetRatingMethod::clear_on_behalf_of_content_owner ( )

inline

Clears the 'onBehalfOfContentOwner' attribute so it is no longer set.

ExecuteAndParseResponse()

util::Status google_youtube_api::VideosResource_GetRatingMethod::ExecuteAndParseResponse ( VideoGetRatingResponse *  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::VideosResource_GetRatingMethod::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::VideosResource_GetRatingMethod::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::VideosResource_GetRatingMethod::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.

---

The documentation for this class was generated from the following files:

• google/youtube_api/you_tube_service.h
• google/youtube_api/you_tube_service.cc