Class: Google::Shopping::Merchant::Accounts::V1::CheckoutSettings

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/shopping/merchant/accounts/v1/checkoutsettings.rb

Overview

CheckoutSettings for a specific merchant.

Defined Under Namespace

Modules: CheckoutEnrollmentState, CheckoutReviewState

Instance Attribute Summary collapse

Instance Attribute Details

#effective_enrollment_state ⇒ ::Google::Shopping::Merchant::Accounts::V1::CheckoutSettings::CheckoutEnrollmentState (readonly)

Returns 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 (for only marketplace sellers).

Returns:



123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
 
# File 'proto_docs/google/shopping/merchant/accounts/v1/checkoutsettings.rb', line 123

class CheckoutSettings
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Enum indicating the enrollment state of merchant in `Checkout`
  # program.
  module CheckoutEnrollmentState
    # Default enrollment state when enrollment state is not specified.
    CHECKOUT_ENROLLMENT_STATE_UNSPECIFIED = 0

    # Merchant has not enrolled into the program.
    INACTIVE = 1

    # Merchant has enrolled into the program by providing either an
    # account level URL or checkout URLs as part of their feed.
    ENROLLED = 2

    # Merchant has previously enrolled but opted out of the program.
    OPTED_OUT = 3
  end

  # Enum indicating the review state of merchant in `Checkout`
  # program.
  module CheckoutReviewState
    # Default review state when review state is not specified.
    CHECKOUT_REVIEW_STATE_UNSPECIFIED = 0

    # Merchant provided URLs are being reviewed for data quality issues.
    IN_REVIEW = 1

    # Merchant account has been approved. Indicates the data quality checks
    # have passed.
    APPROVED = 2

    # Merchant account has been disapproved due to data quality issues.
    DISAPPROVED = 3
  end
end

#effective_review_state ⇒ ::Google::Shopping::Merchant::Accounts::V1::CheckoutSettings::CheckoutReviewState (readonly)

Returns 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 (for only marketplace sellers).

Returns:



123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
 
# File 'proto_docs/google/shopping/merchant/accounts/v1/checkoutsettings.rb', line 123

class CheckoutSettings
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Enum indicating the enrollment state of merchant in `Checkout`
  # program.
  module CheckoutEnrollmentState
    # Default enrollment state when enrollment state is not specified.
    CHECKOUT_ENROLLMENT_STATE_UNSPECIFIED = 0

    # Merchant has not enrolled into the program.
    INACTIVE = 1

    # Merchant has enrolled into the program by providing either an
    # account level URL or checkout URLs as part of their feed.
    ENROLLED = 2

    # Merchant has previously enrolled but opted out of the program.
    OPTED_OUT = 3
  end

  # Enum indicating the review state of merchant in `Checkout`
  # program.
  module CheckoutReviewState
    # Default review state when review state is not specified.
    CHECKOUT_REVIEW_STATE_UNSPECIFIED = 0

    # Merchant provided URLs are being reviewed for data quality issues.
    IN_REVIEW = 1

    # Merchant account has been approved. Indicates the data quality checks
    # have passed.
    APPROVED = 2

    # Merchant account has been disapproved due to data quality issues.
    DISAPPROVED = 3
  end
end

#effective_uri_settings ⇒ ::Google::Shopping::Merchant::Accounts::V1::UriSettings (readonly)

Returns Output only. The effective value of uri_settings for a given merchant. If account level settings are present then this value will be a copy of url settings. Otherwise, it will have the value of the parent account (for only marketplace sellers).

Returns:

  • (::Google::Shopping::Merchant::Accounts::V1::UriSettings) —

    Output only. The effective value of uri_settings for a given merchant. If account level settings are present then this value will be a copy of url settings. Otherwise, it will have the value of the parent account (for only marketplace sellers).



123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
 
# File 'proto_docs/google/shopping/merchant/accounts/v1/checkoutsettings.rb', line 123

class CheckoutSettings
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Enum indicating the enrollment state of merchant in `Checkout`
  # program.
  module CheckoutEnrollmentState
    # Default enrollment state when enrollment state is not specified.
    CHECKOUT_ENROLLMENT_STATE_UNSPECIFIED = 0

    # Merchant has not enrolled into the program.
    INACTIVE = 1

    # Merchant has enrolled into the program by providing either an
    # account level URL or checkout URLs as part of their feed.
    ENROLLED = 2

    # Merchant has previously enrolled but opted out of the program.
    OPTED_OUT = 3
  end

  # Enum indicating the review state of merchant in `Checkout`
  # program.
  module CheckoutReviewState
    # Default review state when review state is not specified.
    CHECKOUT_REVIEW_STATE_UNSPECIFIED = 0

    # Merchant provided URLs are being reviewed for data quality issues.
    IN_REVIEW = 1

    # Merchant account has been approved. Indicates the data quality checks
    # have passed.
    APPROVED = 2

    # Merchant account has been disapproved due to data quality issues.
    DISAPPROVED = 3
  end
end

#eligible_destinations ⇒ ::Array<::Google::Shopping::Type::Destination::DestinationEnum>

Returns Optional. The destinations (also known as Marketing methods) to which the checkout program applies, valid destination values are SHOPPING_ADS, FREE_LISTINGS.

Returns:



123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
 
# File 'proto_docs/google/shopping/merchant/accounts/v1/checkoutsettings.rb', line 123

class CheckoutSettings
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Enum indicating the enrollment state of merchant in `Checkout`
  # program.
  module CheckoutEnrollmentState
    # Default enrollment state when enrollment state is not specified.
    CHECKOUT_ENROLLMENT_STATE_UNSPECIFIED = 0

    # Merchant has not enrolled into the program.
    INACTIVE = 1

    # Merchant has enrolled into the program by providing either an
    # account level URL or checkout URLs as part of their feed.
    ENROLLED = 2

    # Merchant has previously enrolled but opted out of the program.
    OPTED_OUT = 3
  end

  # Enum indicating the review state of merchant in `Checkout`
  # program.
  module CheckoutReviewState
    # Default review state when review state is not specified.
    CHECKOUT_REVIEW_STATE_UNSPECIFIED = 0

    # Merchant provided URLs are being reviewed for data quality issues.
    IN_REVIEW = 1

    # Merchant account has been approved. Indicates the data quality checks
    # have passed.
    APPROVED = 2

    # Merchant account has been disapproved due to data quality issues.
    DISAPPROVED = 3
  end
end

#enrollment_state ⇒ ::Google::Shopping::Merchant::Accounts::V1::CheckoutSettings::CheckoutEnrollmentState (readonly)

Returns Output only. Reflects the merchant enrollment state in Checkout program.

Returns:



123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
 
# File 'proto_docs/google/shopping/merchant/accounts/v1/checkoutsettings.rb', line 123

class CheckoutSettings
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Enum indicating the enrollment state of merchant in `Checkout`
  # program.
  module CheckoutEnrollmentState
    # Default enrollment state when enrollment state is not specified.
    CHECKOUT_ENROLLMENT_STATE_UNSPECIFIED = 0

    # Merchant has not enrolled into the program.
    INACTIVE = 1

    # Merchant has enrolled into the program by providing either an
    # account level URL or checkout URLs as part of their feed.
    ENROLLED = 2

    # Merchant has previously enrolled but opted out of the program.
    OPTED_OUT = 3
  end

  # Enum indicating the review state of merchant in `Checkout`
  # program.
  module CheckoutReviewState
    # Default review state when review state is not specified.
    CHECKOUT_REVIEW_STATE_UNSPECIFIED = 0

    # Merchant provided URLs are being reviewed for data quality issues.
    IN_REVIEW = 1

    # Merchant account has been approved. Indicates the data quality checks
    # have passed.
    APPROVED = 2

    # Merchant account has been disapproved due to data quality issues.
    DISAPPROVED = 3
  end
end

#name ⇒ ::String

Returns Identifier. The resource name of the program configuration settings. Format: accounts/{account}/programs/{program}/checkoutSettings.

Returns:

  • (::String) —

    Identifier. The resource name of the program configuration settings. Format: accounts/{account}/programs/{program}/checkoutSettings



123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
 
# File 'proto_docs/google/shopping/merchant/accounts/v1/checkoutsettings.rb', line 123

class CheckoutSettings
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Enum indicating the enrollment state of merchant in `Checkout`
  # program.
  module CheckoutEnrollmentState
    # Default enrollment state when enrollment state is not specified.
    CHECKOUT_ENROLLMENT_STATE_UNSPECIFIED = 0

    # Merchant has not enrolled into the program.
    INACTIVE = 1

    # Merchant has enrolled into the program by providing either an
    # account level URL or checkout URLs as part of their feed.
    ENROLLED = 2

    # Merchant has previously enrolled but opted out of the program.
    OPTED_OUT = 3
  end

  # Enum indicating the review state of merchant in `Checkout`
  # program.
  module CheckoutReviewState
    # Default review state when review state is not specified.
    CHECKOUT_REVIEW_STATE_UNSPECIFIED = 0

    # Merchant provided URLs are being reviewed for data quality issues.
    IN_REVIEW = 1

    # Merchant account has been approved. Indicates the data quality checks
    # have passed.
    APPROVED = 2

    # Merchant account has been disapproved due to data quality issues.
    DISAPPROVED = 3
  end
end

#review_state ⇒ ::Google::Shopping::Merchant::Accounts::V1::CheckoutSettings::CheckoutReviewState (readonly)

Returns Output only. Reflects the merchant review state in Checkout program. 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.For more details, check the help center doc.

Returns:

  • (::Google::Shopping::Merchant::Accounts::V1::CheckoutSettings::CheckoutReviewState) —

    Output only. Reflects the merchant review state in Checkout program. 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.For more details, check the help center doc.



123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
 
# File 'proto_docs/google/shopping/merchant/accounts/v1/checkoutsettings.rb', line 123

class CheckoutSettings
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Enum indicating the enrollment state of merchant in `Checkout`
  # program.
  module CheckoutEnrollmentState
    # Default enrollment state when enrollment state is not specified.
    CHECKOUT_ENROLLMENT_STATE_UNSPECIFIED = 0

    # Merchant has not enrolled into the program.
    INACTIVE = 1

    # Merchant has enrolled into the program by providing either an
    # account level URL or checkout URLs as part of their feed.
    ENROLLED = 2

    # Merchant has previously enrolled but opted out of the program.
    OPTED_OUT = 3
  end

  # Enum indicating the review state of merchant in `Checkout`
  # program.
  module CheckoutReviewState
    # Default review state when review state is not specified.
    CHECKOUT_REVIEW_STATE_UNSPECIFIED = 0

    # Merchant provided URLs are being reviewed for data quality issues.
    IN_REVIEW = 1

    # Merchant account has been approved. Indicates the data quality checks
    # have passed.
    APPROVED = 2

    # Merchant account has been disapproved due to data quality issues.
    DISAPPROVED = 3
  end
end

#uri_settings ⇒ ::Google::Shopping::Merchant::Accounts::V1::UriSettings

Returns URI settings for cart or checkout URL.

Returns:



123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
 
# File 'proto_docs/google/shopping/merchant/accounts/v1/checkoutsettings.rb', line 123

class CheckoutSettings
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Enum indicating the enrollment state of merchant in `Checkout`
  # program.
  module CheckoutEnrollmentState
    # Default enrollment state when enrollment state is not specified.
    CHECKOUT_ENROLLMENT_STATE_UNSPECIFIED = 0

    # Merchant has not enrolled into the program.
    INACTIVE = 1

    # Merchant has enrolled into the program by providing either an
    # account level URL or checkout URLs as part of their feed.
    ENROLLED = 2

    # Merchant has previously enrolled but opted out of the program.
    OPTED_OUT = 3
  end

  # Enum indicating the review state of merchant in `Checkout`
  # program.
  module CheckoutReviewState
    # Default review state when review state is not specified.
    CHECKOUT_REVIEW_STATE_UNSPECIFIED = 0

    # Merchant provided URLs are being reviewed for data quality issues.
    IN_REVIEW = 1

    # Merchant account has been approved. Indicates the data quality checks
    # have passed.
    APPROVED = 2

    # Merchant account has been disapproved due to data quality issues.
    DISAPPROVED = 3
  end
end