Class: Google::Shopping::Merchant::Accounts::V1beta::Program

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

Overview

Defines participation in a given program for the specified account.

Programs provide a mechanism for adding functionality to merchant accounts. A typical example of this is the Free product listings program, which enables products from a merchant's store to be shown across Google for free.

Defined Under Namespace

Modules: State Classes: Requirement

Instance Attribute Summary collapse

Instance Attribute Details

#active_region_codes ⇒ ::Array<::String> (readonly)

Returns Output only. The regions in which the account is actively participating in the program. Active regions are defined as those where all program requirements affecting the regions have been met.

Region codes are defined by CLDR. This is either a country where the program applies specifically to that country or 001 when the program applies globally.

Returns:

  • (::Array<::String>) —

    Output only. The regions in which the account is actively participating in the program. Active regions are defined as those where all program requirements affecting the regions have been met.

    Region codes are defined by CLDR. This is either a country where the program applies specifically to that country or 001 when the program applies globally.



55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
 
# File 'proto_docs/google/shopping/merchant/accounts/v1beta/programs.rb', line 55

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

  # Defines a requirement specified for participation in the program.
  # @!attribute [r] title
  #   @return [::String]
  #     Output only. Name of the requirement.
  # @!attribute [r] documentation_uri
  #   @return [::String]
  #     Output only. The URL of a help page describing the requirement.
  # @!attribute [r] affected_region_codes
  #   @return [::Array<::String>]
  #     Output only. The regions that are currently affected by this requirement
  #     not being met.
  #
  #     Region codes are defined by [CLDR](https://cldr.unicode.org/). This is
  #     either a country where the program applies specifically to that country
  #     or `001` when the program applies globally.
  class Requirement
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Possible program participation states for the account.
  module State
    # Default value. This value is unused.
    STATE_UNSPECIFIED = 0

    # The account is not eligible to participate in the program.
    NOT_ELIGIBLE = 1

    # The account is eligible to participate in the program.
    ELIGIBLE = 2

    # The program is enabled for the account.
    ENABLED = 3
  end
end

#documentation_uri ⇒ ::String (readonly)

Returns Output only. The URL of a Merchant Center help page describing the program.

Returns:

  • (::String) —

    Output only. The URL of a Merchant Center help page describing the program.



55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
 
# File 'proto_docs/google/shopping/merchant/accounts/v1beta/programs.rb', line 55

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

  # Defines a requirement specified for participation in the program.
  # @!attribute [r] title
  #   @return [::String]
  #     Output only. Name of the requirement.
  # @!attribute [r] documentation_uri
  #   @return [::String]
  #     Output only. The URL of a help page describing the requirement.
  # @!attribute [r] affected_region_codes
  #   @return [::Array<::String>]
  #     Output only. The regions that are currently affected by this requirement
  #     not being met.
  #
  #     Region codes are defined by [CLDR](https://cldr.unicode.org/). This is
  #     either a country where the program applies specifically to that country
  #     or `001` when the program applies globally.
  class Requirement
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Possible program participation states for the account.
  module State
    # Default value. This value is unused.
    STATE_UNSPECIFIED = 0

    # The account is not eligible to participate in the program.
    NOT_ELIGIBLE = 1

    # The account is eligible to participate in the program.
    ELIGIBLE = 2

    # The program is enabled for the account.
    ENABLED = 3
  end
end

#name ⇒ ::String

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

Returns:

  • (::String) —

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



55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
 
# File 'proto_docs/google/shopping/merchant/accounts/v1beta/programs.rb', line 55

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

  # Defines a requirement specified for participation in the program.
  # @!attribute [r] title
  #   @return [::String]
  #     Output only. Name of the requirement.
  # @!attribute [r] documentation_uri
  #   @return [::String]
  #     Output only. The URL of a help page describing the requirement.
  # @!attribute [r] affected_region_codes
  #   @return [::Array<::String>]
  #     Output only. The regions that are currently affected by this requirement
  #     not being met.
  #
  #     Region codes are defined by [CLDR](https://cldr.unicode.org/). This is
  #     either a country where the program applies specifically to that country
  #     or `001` when the program applies globally.
  class Requirement
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Possible program participation states for the account.
  module State
    # Default value. This value is unused.
    STATE_UNSPECIFIED = 0

    # The account is not eligible to participate in the program.
    NOT_ELIGIBLE = 1

    # The account is eligible to participate in the program.
    ELIGIBLE = 2

    # The program is enabled for the account.
    ENABLED = 3
  end
end

#state ⇒ ::Google::Shopping::Merchant::Accounts::V1beta::Program::State (readonly)

Returns Output only. The participation state of the account in the program.

Returns:



55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
 
# File 'proto_docs/google/shopping/merchant/accounts/v1beta/programs.rb', line 55

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

  # Defines a requirement specified for participation in the program.
  # @!attribute [r] title
  #   @return [::String]
  #     Output only. Name of the requirement.
  # @!attribute [r] documentation_uri
  #   @return [::String]
  #     Output only. The URL of a help page describing the requirement.
  # @!attribute [r] affected_region_codes
  #   @return [::Array<::String>]
  #     Output only. The regions that are currently affected by this requirement
  #     not being met.
  #
  #     Region codes are defined by [CLDR](https://cldr.unicode.org/). This is
  #     either a country where the program applies specifically to that country
  #     or `001` when the program applies globally.
  class Requirement
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Possible program participation states for the account.
  module State
    # Default value. This value is unused.
    STATE_UNSPECIFIED = 0

    # The account is not eligible to participate in the program.
    NOT_ELIGIBLE = 1

    # The account is eligible to participate in the program.
    ELIGIBLE = 2

    # The program is enabled for the account.
    ENABLED = 3
  end
end

#unmet_requirements ⇒ ::Array<::Google::Shopping::Merchant::Accounts::V1beta::Program::Requirement> (readonly)

Returns Output only. The requirements that the account has not yet satisfied that are affecting participation in the program.

Returns:



55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
 
# File 'proto_docs/google/shopping/merchant/accounts/v1beta/programs.rb', line 55

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

  # Defines a requirement specified for participation in the program.
  # @!attribute [r] title
  #   @return [::String]
  #     Output only. Name of the requirement.
  # @!attribute [r] documentation_uri
  #   @return [::String]
  #     Output only. The URL of a help page describing the requirement.
  # @!attribute [r] affected_region_codes
  #   @return [::Array<::String>]
  #     Output only. The regions that are currently affected by this requirement
  #     not being met.
  #
  #     Region codes are defined by [CLDR](https://cldr.unicode.org/). This is
  #     either a country where the program applies specifically to that country
  #     or `001` when the program applies globally.
  class Requirement
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Possible program participation states for the account.
  module State
    # Default value. This value is unused.
    STATE_UNSPECIFIED = 0

    # The account is not eligible to participate in the program.
    NOT_ELIGIBLE = 1

    # The account is eligible to participate in the program.
    ELIGIBLE = 2

    # The program is enabled for the account.
    ENABLED = 3
  end
end