Class: Google::Apis::MybusinessplaceactionsV1::PlaceActionLink

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

Overview

Represents a place action link and its attributes.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ PlaceActionLink

Returns a new instance of PlaceActionLink.

[View source]

153
154
155
 
# File 'lib/google/apis/mybusinessplaceactions_v1/classes.rb', line 153

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

Instance Attribute Details

#create_time ⇒ String

Output only. The time when the place action link was created. Corresponds to the JSON property createTime

Returns:

  • (String) 

103
104
105
 
# File 'lib/google/apis/mybusinessplaceactions_v1/classes.rb', line 103

def create_time
  @create_time
end

#is_editable ⇒ Boolean Also known as: is_editable?

Output only. Indicates whether this link can be edited by the client. Corresponds to the JSON property isEditable

Returns:

  • (Boolean) 

108
109
110
 
# File 'lib/google/apis/mybusinessplaceactions_v1/classes.rb', line 108

def is_editable
  @is_editable
end

#is_preferred ⇒ Boolean Also known as: is_preferred?

Optional. Whether this link is preferred by the merchant. Only one link can be marked as preferred per place action type at a location. If a future request marks a different link as preferred for the same place action type, then the current preferred link (if any exists) will lose its preference. Corresponds to the JSON property isPreferred

Returns:

  • (Boolean) 

117
118
119
 
# File 'lib/google/apis/mybusinessplaceactions_v1/classes.rb', line 117

def is_preferred
  @is_preferred
end

#name ⇒ String

Optional. The resource name, in the format locations/location_id/ placeActionLinks/place_action_link_id`. The name field will only be considered in UpdatePlaceActionLink and DeletePlaceActionLink requests for updating and deleting links respectively. However, it will be ignored in CreatePlaceActionLink request, whereplace_action_link_idwill be assigned by the server on successful creation of a new link and returned as part of the response. Corresponds to the JSON propertyname`

Returns:

  • (String) 

129
130
131
 
# File 'lib/google/apis/mybusinessplaceactions_v1/classes.rb', line 129

def name
  @name
end

#place_action_type ⇒ String

Required. The type of place action that can be performed using this link. Corresponds to the JSON property placeActionType

Returns:

  • (String) 

134
135
136
 
# File 'lib/google/apis/mybusinessplaceactions_v1/classes.rb', line 134

def place_action_type
  @place_action_type
end

#provider_type ⇒ String

Output only. Specifies the provider type. Corresponds to the JSON property providerType

Returns:

  • (String) 

139
140
141
 
# File 'lib/google/apis/mybusinessplaceactions_v1/classes.rb', line 139

def provider_type
  @provider_type
end

#update_time ⇒ String

Output only. The time when the place action link was last modified. Corresponds to the JSON property updateTime

Returns:

  • (String) 

144
145
146
 
# File 'lib/google/apis/mybusinessplaceactions_v1/classes.rb', line 144

def update_time
  @update_time
end

#uri ⇒ String

Required. The link uri. The same uri can be reused for different action types across different locations. However, only one place action link is allowed for each unique combination of (uri, place action type, location). Corresponds to the JSON property uri

Returns:

  • (String) 

151
152
153
 
# File 'lib/google/apis/mybusinessplaceactions_v1/classes.rb', line 151

def uri
  @uri
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object

[View source]

158
159
160
161
162
163
164
165
166
167
 
# File 'lib/google/apis/mybusinessplaceactions_v1/classes.rb', line 158

def update!(**args)
  @create_time = args[:create_time] if args.key?(:create_time)
  @is_editable = args[:is_editable] if args.key?(:is_editable)
  @is_preferred = args[:is_preferred] if args.key?(:is_preferred)
  @name = args[:name] if args.key?(:name)
  @place_action_type = args[:place_action_type] if args.key?(:place_action_type)
  @provider_type = args[:provider_type] if args.key?(:provider_type)
  @update_time = args[:update_time] if args.key?(:update_time)
  @uri = args[:uri] if args.key?(:uri)
end