Class: Google::Apis::MerchantapiLfpV1beta::LfpStore

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

Overview

A store for the merchant. This will be used to match to a store under the Google Business Profile of the target merchant. If a matching store can't be found, the inventories or sales submitted with the store code will not be used.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ LfpStore

Returns a new instance of LfpStore.



329
330
331
 
# File 'lib/google/apis/merchantapi_lfp_v1beta/classes.rb', line 329

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

Instance Attribute Details

#gcid_category ⇒ Array<String>

Optional. Google My Business category id. Corresponds to the JSON property gcidCategory

Returns:

  • (Array<String>) 


260
261
262
 
# File 'lib/google/apis/merchantapi_lfp_v1beta/classes.rb', line 260

def gcid_category
  @gcid_category
end

#matching_state ⇒ String

Optional. Output only. The state of matching to a Google Business Profile. See matchingStateHint for further details if no match is found. Corresponds to the JSON property matchingState

Returns:

  • (String) 


266
267
268
 
# File 'lib/google/apis/merchantapi_lfp_v1beta/classes.rb', line 266

def matching_state
  @matching_state
end

#matching_state_hint ⇒ String

Optional. Output only. The hint of why the matching has failed. This is only set when matchingState=STORE_MATCHING_STATE_FAILED. Possible values are: - " linked-store-not-found": There aren't any Google Business Profile stores available for matching. - "store-match-not-found": The provided LfpStore couldn't be matched to any of the connected Google Business Profile stores. Merchant Center account is connected correctly and stores are available on Google Business Profile, but the LfpStore location address does not match with Google Business Profile stores' addresses. Update the LfpStore address or Google Business Profile store address to match correctly. - "store-match- unverified": The provided LfpStore couldn't be matched to any of the connected Google Business Profile stores, as the matched Google Business Profile store is unverified. Go through the Google Business Profile verification process to match correctly. Corresponds to the JSON property matchingStateHint

Returns:

  • (String) 


283
284
285
 
# File 'lib/google/apis/merchantapi_lfp_v1beta/classes.rb', line 283

def matching_state_hint
  @matching_state_hint
end

#name ⇒ String

Output only. Identifier. The name of the LfpStore resource. Format: accounts/account/lfpStores/target_merchant~store_code` Corresponds to the JSON propertyname`

Returns:

  • (String) 


289
290
291
 
# File 'lib/google/apis/merchantapi_lfp_v1beta/classes.rb', line 289

def name
  @name
end

#phone_number ⇒ String

Optional. The store phone number in E.164 format. Example: +15556767888 Corresponds to the JSON property phoneNumber

Returns:

  • (String) 


295
296
297
 
# File 'lib/google/apis/merchantapi_lfp_v1beta/classes.rb', line 295

def phone_number
  @phone_number
end

#place_id ⇒ String

Optional. The Google Place Id of the store location. Corresponds to the JSON property placeId

Returns:

  • (String) 


301
302
303
 
# File 'lib/google/apis/merchantapi_lfp_v1beta/classes.rb', line 301

def place_id
  @place_id
end

#store_address ⇒ String

Required. The street address of the store. Example: 1600 Amphitheatre Pkwy, Mountain View, CA 94043, USA. Corresponds to the JSON property storeAddress

Returns:

  • (String) 


307
308
309
 
# File 'lib/google/apis/merchantapi_lfp_v1beta/classes.rb', line 307

def store_address
  @store_address
end

#store_code ⇒ String

Required. Immutable. A store identifier that is unique for the target merchant. Corresponds to the JSON property storeCode

Returns:

  • (String) 


312
313
314
 
# File 'lib/google/apis/merchantapi_lfp_v1beta/classes.rb', line 312

def store_code
  @store_code
end

#store_name ⇒ String

Optional. The merchant or store name. Corresponds to the JSON property storeName

Returns:

  • (String) 


317
318
319
 
# File 'lib/google/apis/merchantapi_lfp_v1beta/classes.rb', line 317

def store_name
  @store_name
end

#target_account ⇒ Fixnum

Required. The Merchant Center id of the merchant to submit the store for. Corresponds to the JSON property targetAccount

Returns:

  • (Fixnum) 


322
323
324
 
# File 'lib/google/apis/merchantapi_lfp_v1beta/classes.rb', line 322

def 
  @target_account
end

#website_uri ⇒ String

Optional. The website URL for the store or merchant. Corresponds to the JSON property websiteUri

Returns:

  • (String) 


327
328
329
 
# File 'lib/google/apis/merchantapi_lfp_v1beta/classes.rb', line 327

def website_uri
  @website_uri
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



334
335
336
337
338
339
340
341
342
343
344
345
346
 
# File 'lib/google/apis/merchantapi_lfp_v1beta/classes.rb', line 334

def update!(**args)
  @gcid_category = args[:gcid_category] if args.key?(:gcid_category)
  @matching_state = args[:matching_state] if args.key?(:matching_state)
  @matching_state_hint = args[:matching_state_hint] if args.key?(:matching_state_hint)
  @name = args[:name] if args.key?(:name)
  @phone_number = args[:phone_number] if args.key?(:phone_number)
  @place_id = args[:place_id] if args.key?(:place_id)
  @store_address = args[:store_address] if args.key?(:store_address)
  @store_code = args[:store_code] if args.key?(:store_code)
  @store_name = args[:store_name] if args.key?(:store_name)
  @target_account = args[:target_account] if args.key?(:target_account)
  @website_uri = args[:website_uri] if args.key?(:website_uri)
end