Class: Google::Apis::MerchantapiAccountsV1beta::Program

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/merchantapi_accounts_v1beta/classes.rb,
lib/google/apis/merchantapi_accounts_v1beta/representations.rb,
lib/google/apis/merchantapi_accounts_v1beta/representations.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.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ Program

Returns a new instance of Program.



2025
2026
2027
 
# File 'lib/google/apis/merchantapi_accounts_v1beta/classes.rb', line 2025

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

Instance Attribute Details

#active_region_codes ⇒ 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. Corresponds to the JSON property activeRegionCodes

Returns:

  • (Array<String>) 


2001
2002
2003
 
# File 'lib/google/apis/merchantapi_accounts_v1beta/classes.rb', line 2001

def active_region_codes
  @active_region_codes
end

#documentation_uri ⇒ String

Output only. The URL of a Merchant Center help page describing the program. Corresponds to the JSON property documentationUri

Returns:

  • (String) 


2006
2007
2008
 
# File 'lib/google/apis/merchantapi_accounts_v1beta/classes.rb', line 2006

def documentation_uri
  @documentation_uri
end

#name ⇒ String

Identifier. The resource name of the program. Format: accounts/account/ programs/program` Corresponds to the JSON propertyname`

Returns:

  • (String) 


2012
2013
2014
 
# File 'lib/google/apis/merchantapi_accounts_v1beta/classes.rb', line 2012

def name
  @name
end

#state ⇒ String

Output only. The participation state of the account in the program. Corresponds to the JSON property state

Returns:

  • (String) 


2017
2018
2019
 
# File 'lib/google/apis/merchantapi_accounts_v1beta/classes.rb', line 2017

def state
  @state
end

#unmet_requirements ⇒ Array<Google::Apis::MerchantapiAccountsV1beta::Requirement>

Output only. The requirements that the account has not yet satisfied that are affecting participation in the program. Corresponds to the JSON property unmetRequirements

Returns:



2023
2024
2025
 
# File 'lib/google/apis/merchantapi_accounts_v1beta/classes.rb', line 2023

def unmet_requirements
  @unmet_requirements
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2030
2031
2032
2033
2034
2035
2036
 
# File 'lib/google/apis/merchantapi_accounts_v1beta/classes.rb', line 2030

def update!(**args)
  @active_region_codes = args[:active_region_codes] if args.key?(:active_region_codes)
  @documentation_uri = args[:documentation_uri] if args.key?(:documentation_uri)
  @name = args[:name] if args.key?(:name)
  @state = args[:state] if args.key?(:state)
  @unmet_requirements = args[:unmet_requirements] if args.key?(:unmet_requirements)
end