Class: Google::Apis::PartnersV2::RequestMetadata

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
generated/google/apis/partners_v2/classes.rb,
generated/google/apis/partners_v2/representations.rb,
generated/google/apis/partners_v2/representations.rb

Overview

Common data that is in each API request.

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Core::JsonObjectSupport

#to_json

Methods included from Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ RequestMetadata

Returns a new instance of RequestMetadata



1939
1940
1941
 
# File 'generated/google/apis/partners_v2/classes.rb', line 1939

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#experiment_ids ⇒ Array<String>

Experiment IDs the current request belongs to. Corresponds to the JSON property experimentIds

Returns:

  • (Array<String>) 


1916
1917
1918
 
# File 'generated/google/apis/partners_v2/classes.rb', line 1916

def experiment_ids
  @experiment_ids
end

#locale ⇒ String

Locale to use for the current request. Corresponds to the JSON property locale

Returns:

  • (String) 


1921
1922
1923
 
# File 'generated/google/apis/partners_v2/classes.rb', line 1921

def locale
  @locale
end

#partners_session_id ⇒ String

Google Partners session ID. Corresponds to the JSON property partnersSessionId

Returns:

  • (String) 


1926
1927
1928
 
# File 'generated/google/apis/partners_v2/classes.rb', line 1926

def partners_session_id
  @partners_session_id
end

#traffic_source ⇒ Google::Apis::PartnersV2::TrafficSource

Source of traffic for the current request. Corresponds to the JSON property trafficSource

Returns:



1931
1932
1933
 
# File 'generated/google/apis/partners_v2/classes.rb', line 1931

def traffic_source
  @traffic_source
end

#user_overrides ⇒ Google::Apis::PartnersV2::UserOverrides

Values to use instead of the user's respective defaults. These are only honored by whitelisted products. Corresponds to the JSON property userOverrides

Returns:



1937
1938
1939
 
# File 'generated/google/apis/partners_v2/classes.rb', line 1937

def user_overrides
  @user_overrides
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1944
1945
1946
1947
1948
1949
1950
 
# File 'generated/google/apis/partners_v2/classes.rb', line 1944

def update!(**args)
  @experiment_ids = args[:experiment_ids] if args.key?(:experiment_ids)
  @locale = args[:locale] if args.key?(:locale)
  @partners_session_id = args[:partners_session_id] if args.key?(:partners_session_id)
  @traffic_source = args[:traffic_source] if args.key?(:traffic_source)
  @user_overrides = args[:user_overrides] if args.key?(:user_overrides)
end