Class: Google::Apis::ContentV2_1::Recommendation

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

Recommendations are suggested ways to improve your merchant account's performance. For example, to engage with a feature, or start using a new Google product.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ Recommendation

Returns a new instance of Recommendation.



11508
11509
11510
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 11508

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

Instance Attribute Details

#additional_call_to_action ⇒ Array<Google::Apis::ContentV2_1::RecommendationCallToAction>

Output only. CTAs of this recommendation. Repeated. Corresponds to the JSON property additionalCallToAction

Returns:



11438
11439
11440
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 11438

def additional_call_to_action
  @additional_call_to_action
end

#additional_descriptions ⇒ Array<Google::Apis::ContentV2_1::RecommendationDescription>

Output only. List of additional localized descriptions for a recommendation. Localication uses the languageCode field in GenerateRecommendations requests. Not all description types are guaranteed to be present and we recommend to rely on default description. Corresponds to the JSON property additionalDescriptions

Returns:



11446
11447
11448
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 11446

def additional_descriptions
  @additional_descriptions
end

#creative ⇒ Array<Google::Apis::ContentV2_1::RecommendationCreative>

Output only. Any creatives attached to the recommendation. Repeated. Corresponds to the JSON property creative

Returns:



11451
11452
11453
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 11451

def creative
  @creative
end

#default_call_to_action ⇒ Google::Apis::ContentV2_1::RecommendationCallToAction

Call to action (CTA) that explains how a merchant can implement this recommendation Corresponds to the JSON property defaultCallToAction

Returns:



11457
11458
11459
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 11457

def default_call_to_action
  @default_call_to_action
end

#default_description ⇒ String

Optional. Localized recommendation description. The localization the @link GenerateRecommendationsRequest.language_codefield in `@link ` GenerateRecommendationsRequest requests. Corresponds to the JSON property defaultDescription

Returns:

  • (String) 


11464
11465
11466
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 11464

def default_description
  @default_description
end

#numerical_impact ⇒ Fixnum

Optional. A numerical score of the impact from the recommendation's description. For example, a recommendation might suggest an upward trend in sales for a certain product. Higher number means larger impact. Corresponds to the JSON property numericalImpact

Returns:

  • (Fixnum) 


11471
11472
11473
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 11471

def numerical_impact
  @numerical_impact
end

Optional. Indicates whether a user needs to pay when they complete the user journey suggested by the recommendation. Corresponds to the JSON property paid

Returns:

  • (Boolean) 


11477
11478
11479
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 11477

def paid
  @paid
end

#recommendation_name ⇒ String

Optional. Localized recommendation name. The localization uses the @link GenerateRecommendationsRequest.language_codefield in `@link ` GenerateRecommendationsRequest requests. Corresponds to the JSON property recommendationName

Returns:

  • (String) 


11485
11486
11487
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 11485

def recommendation_name
  @recommendation_name
end

#sub_type ⇒ String

Optional. Subtype of the recommendations. Only applicable when multiple recommendations can be generated per type, and is used as an identifier of recommendation under the same recommendation type. Corresponds to the JSON property subType

Returns:

  • (String) 


11492
11493
11494
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 11492

def sub_type
  @sub_type
end

#title ⇒ String

Optional. Localized Recommendation Title. Localization uses the @link GenerateRecommendationsRequest.language_codefield in `@link ` GenerateRecommendationsRequest requests. Corresponds to the JSON property title

Returns:

  • (String) 


11499
11500
11501
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 11499

def title
  @title
end

#type ⇒ String

Output only. Type of the recommendation. List of currently available recommendation types: - OPPORTUNITY_CREATE_NEW_COLLECTION - OPPORTUNITY_CREATE_EMAIL_CAMPAIGN Corresponds to the JSON property type

Returns:

  • (String) 


11506
11507
11508
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 11506

def type
  @type
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



11513
11514
11515
11516
11517
11518
11519
11520
11521
11522
11523
11524
11525
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 11513

def update!(**args)
  @additional_call_to_action = args[:additional_call_to_action] if args.key?(:additional_call_to_action)
  @additional_descriptions = args[:additional_descriptions] if args.key?(:additional_descriptions)
  @creative = args[:creative] if args.key?(:creative)
  @default_call_to_action = args[:default_call_to_action] if args.key?(:default_call_to_action)
  @default_description = args[:default_description] if args.key?(:default_description)
  @numerical_impact = args[:numerical_impact] if args.key?(:numerical_impact)
  @paid = args[:paid] if args.key?(:paid)
  @recommendation_name = args[:recommendation_name] if args.key?(:recommendation_name)
  @sub_type = args[:sub_type] if args.key?(:sub_type)
  @title = args[:title] if args.key?(:title)
  @type = args[:type] if args.key?(:type)
end