google_analytics_api::ManagementResource_CustomDimensionsResource_PatchMethod Class Reference

#include <analytics_service.h>

Inheritance diagram for google_analytics_api::ManagementResource_CustomDimensionsResource_PatchMethod:

Public Member Functions
	ManagementResource_CustomDimensionsResource_PatchMethod (const AnalyticsService *_service_, client::AuthorizationCredential *_credential_, const absl::string_view &account_id, const absl::string_view &web_property_id, const absl::string_view &custom_dimension_id, const CustomDimension &_content_)
virtual	~ManagementResource_CustomDimensionsResource_PatchMethod ()
void	clear_ignore_custom_data_source_links ()
bool	get_ignore_custom_data_source_links () const
void	set_ignore_custom_data_source_links (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 (CustomDimension *data)
Public Member Functions inherited from google_analytics_api::AnalyticsServiceBaseRequest
	AnalyticsServiceBaseRequest (const client::ClientService *service, client::AuthorizationCredential *credential, client::HttpRequest::HttpMethod method, const StringPiece &uri_template)
virtual	~AnalyticsServiceBaseRequest ()
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_analytics_api::AnalyticsServiceBaseRequest
void	AddJsonContentToRequest (const client::JsonCppData *content)

Detailed Description

Implements the patch 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/analytics.edit

Constructor & Destructor Documentation

ManagementResource_CustomDimensionsResource_PatchMethod()

google_analytics_api::ManagementResource_CustomDimensionsResource_PatchMethod::ManagementResource_CustomDimensionsResource_PatchMethod	(	const AnalyticsService *	_service_,
		client::AuthorizationCredential *	_credential_,
		const absl::string_view &	account_id,
		const absl::string_view &	web_property_id,
		const absl::string_view &	custom_dimension_id,
		const CustomDimension &	_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]	account_id	Account ID for the custom dimension to update.
[in]	web_property_id	Web property ID for the custom dimension to update.
[in]	custom_dimension_id	Custom dimension ID for the custom dimension to update.
[in]	<em>content</em>	The data object to patch.

~ManagementResource_CustomDimensionsResource_PatchMethod()

google_analytics_api::ManagementResource_CustomDimensionsResource_PatchMethod::~ManagementResource_CustomDimensionsResource_PatchMethod ( )

virtual

Standard destructor.

Member Function Documentation

AppendOptionalQueryParameters()

util::Status google_analytics_api::ManagementResource_CustomDimensionsResource_PatchMethod::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_analytics_api::AnalyticsServiceBaseRequest.

AppendVariable()

util::Status google_analytics_api::ManagementResource_CustomDimensionsResource_PatchMethod::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_analytics_api::AnalyticsServiceBaseRequest.

clear_ignore_custom_data_source_links()

void google_analytics_api::ManagementResource_CustomDimensionsResource_PatchMethod::clear_ignore_custom_data_source_links ( )

inline

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

ExecuteAndParseResponse()

util::Status google_analytics_api::ManagementResource_CustomDimensionsResource_PatchMethod::ExecuteAndParseResponse ( CustomDimension *  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_ignore_custom_data_source_links()

bool google_analytics_api::ManagementResource_CustomDimensionsResource_PatchMethod::get_ignore_custom_data_source_links ( ) const

inline

Gets the optional 'ignoreCustomDataSourceLinks' attribute.

If the value is not set then the default value will be returned.

set_ignore_custom_data_source_links()

void google_analytics_api::ManagementResource_CustomDimensionsResource_PatchMethod::set_ignore_custom_data_source_links ( bool  value )

inline

Sets the 'ignoreCustomDataSourceLinks' attribute.

Parameters

[in]

value

Force the update and ignore any warnings related to the custom dimension being linked to a custom data source / data set.

---

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

• google/analytics_api/analytics_service.h
• google/analytics_api/analytics_service.cc