Class: Google::Apis::ContentV2_1::CheckoutSettings

Inherits:
Object
  • Object
show all
Includes:
Google::Apis::Core::Hashable, Google::Apis::Core::JsonObjectSupport
Defined in:
lib/google/apis/content_v2_1/classes.rb,
lib/google/apis/content_v2_1/representations.rb,
lib/google/apis/content_v2_1/representations.rb

Overview

CheckoutSettings for a specific merchant ID.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ CheckoutSettings

Returns a new instance of CheckoutSettings.



2903
2904
2905
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 2903

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

Instance Attribute Details

#effective_enrollment_state ⇒ String

Output only. The effective value of enrollment state for a given merchant ID. If account level settings are present then this value will be a copy of the account level settings. Otherwise, it will have the value of the parent account. Corresponds to the JSON property effectiveEnrollmentState

Returns:

  • (String) 


2856
2857
2858
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 2856

def effective_enrollment_state
  @effective_enrollment_state
end

#effective_review_state ⇒ String

Output only. The effective value of review state for a given merchant ID. If account level settings are present then this value will be a copy of the account level settings. Otherwise, it will have the value of the parent account. Corresponds to the JSON property effectiveReviewState

Returns:

  • (String) 


2864
2865
2866
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 2864

def effective_review_state
  @effective_review_state
end

#effective_uri_settings ⇒ Google::Apis::ContentV2_1::UrlSettings

Specifications related to the Checkout URL. The UriTemplate is of the form https://www.mystore.com/checkout?item_id=idwhereid`will be automatically replaced with data from the merchant account with this attribute [offer_id](https://developers.google.com/shopping-content/reference/rest/v2.1/ products#Product.FIELDS.offer_id) Corresponds to the JSON propertyeffectiveUriSettings`

Returns:



2873
2874
2875
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 2873

def effective_uri_settings
  @effective_uri_settings
end

#enrollment_state ⇒ String

Output only. Reflects the merchant enrollment state in Checkout feature. Corresponds to the JSON property enrollmentState

Returns:

  • (String) 


2878
2879
2880
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 2878

def enrollment_state
  @enrollment_state
end

#merchant_id ⇒ Fixnum

Required. The ID of the account. Corresponds to the JSON property merchantId

Returns:

  • (Fixnum) 


2883
2884
2885
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 2883

def merchant_id
  @merchant_id
end

#review_state ⇒ String

Output only. Reflects the merchant review state in Checkout feature. This is set based on the data quality reviews of the URL provided by the merchant. A merchant with enrollment state as ENROLLED can be in the following review states: IN_REVIEW, APPROVED or DISAPPROVED. A merchant must be in an enrollment_state of ENROLLED before a review can begin for the merchant. Corresponds to the JSON property reviewState

Returns:

  • (String) 


2892
2893
2894
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 2892

def review_state
  @review_state
end

#uri_settings ⇒ Google::Apis::ContentV2_1::UrlSettings

Specifications related to the Checkout URL. The UriTemplate is of the form https://www.mystore.com/checkout?item_id=idwhereid`will be automatically replaced with data from the merchant account with this attribute [offer_id](https://developers.google.com/shopping-content/reference/rest/v2.1/ products#Product.FIELDS.offer_id) Corresponds to the JSON propertyuriSettings`

Returns:



2901
2902
2903
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 2901

def uri_settings
  @uri_settings
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2908
2909
2910
2911
2912
2913
2914
2915
2916
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 2908

def update!(**args)
  @effective_enrollment_state = args[:effective_enrollment_state] if args.key?(:effective_enrollment_state)
  @effective_review_state = args[:effective_review_state] if args.key?(:effective_review_state)
  @effective_uri_settings = args[:effective_uri_settings] if args.key?(:effective_uri_settings)
  @enrollment_state = args[:enrollment_state] if args.key?(:enrollment_state)
  @merchant_id = args[:merchant_id] if args.key?(:merchant_id)
  @review_state = args[:review_state] if args.key?(:review_state)
  @uri_settings = args[:uri_settings] if args.key?(:uri_settings)
end