Class: Google::Shopping::Merchant::Lfp::V1beta::LfpStore

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/shopping/merchant/lfp/v1beta/lfpstore.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.

Defined Under Namespace

Modules: StoreMatchingState

Instance Attribute Summary collapse

Instance Attribute Details

#gcid_category ⇒ ::Array<::String>

Returns Optional. Google My Business category id.

Returns:



90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
 
# File 'proto_docs/google/shopping/merchant/lfp/v1beta/lfpstore.rb', line 90

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

  # The state of matching `LfpStore` to a Google Business Profile.
  module StoreMatchingState
    # Store matching state unspecified.
    STORE_MATCHING_STATE_UNSPECIFIED = 0

    # The `LfpStore` is successfully matched with a Google Business Profile
    # store.
    STORE_MATCHING_STATE_MATCHED = 1

    # The `LfpStore` is not matched with a Google Business Profile store.
    STORE_MATCHING_STATE_FAILED = 2
  end
end

#matching_state ⇒ ::Google::Shopping::Merchant::Lfp::V1beta::LfpStore::StoreMatchingState (readonly)

Returns Optional. Output only. The state of matching to a Google Business Profile. See matchingStateHint for further details if no match is found.

Returns:



90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
 
# File 'proto_docs/google/shopping/merchant/lfp/v1beta/lfpstore.rb', line 90

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

  # The state of matching `LfpStore` to a Google Business Profile.
  module StoreMatchingState
    # Store matching state unspecified.
    STORE_MATCHING_STATE_UNSPECIFIED = 0

    # The `LfpStore` is successfully matched with a Google Business Profile
    # store.
    STORE_MATCHING_STATE_MATCHED = 1

    # The `LfpStore` is not matched with a Google Business Profile store.
    STORE_MATCHING_STATE_FAILED = 2
  end
end

#matching_state_hint ⇒ ::String (readonly)

Returns 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.

Returns:

  • (::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.


90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
 
# File 'proto_docs/google/shopping/merchant/lfp/v1beta/lfpstore.rb', line 90

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

  # The state of matching `LfpStore` to a Google Business Profile.
  module StoreMatchingState
    # Store matching state unspecified.
    STORE_MATCHING_STATE_UNSPECIFIED = 0

    # The `LfpStore` is successfully matched with a Google Business Profile
    # store.
    STORE_MATCHING_STATE_MATCHED = 1

    # The `LfpStore` is not matched with a Google Business Profile store.
    STORE_MATCHING_STATE_FAILED = 2
  end
end

#name ⇒ ::String (readonly)

Returns Output only. Identifier. The name of the LfpStore resource. Format: accounts/{account}/lfpStores/{target_merchant}~{store_code}.

Returns:

  • (::String) —

    Output only. Identifier. The name of the LfpStore resource. Format: accounts/{account}/lfpStores/{target_merchant}~{store_code}



90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
 
# File 'proto_docs/google/shopping/merchant/lfp/v1beta/lfpstore.rb', line 90

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

  # The state of matching `LfpStore` to a Google Business Profile.
  module StoreMatchingState
    # Store matching state unspecified.
    STORE_MATCHING_STATE_UNSPECIFIED = 0

    # The `LfpStore` is successfully matched with a Google Business Profile
    # store.
    STORE_MATCHING_STATE_MATCHED = 1

    # The `LfpStore` is not matched with a Google Business Profile store.
    STORE_MATCHING_STATE_FAILED = 2
  end
end

#phone_number ⇒ ::String

Returns Optional. The store phone number in E.164 format. Example: +15556767888.

Returns:

  • (::String) —

    Optional. The store phone number in E.164 format. Example: +15556767888



90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
 
# File 'proto_docs/google/shopping/merchant/lfp/v1beta/lfpstore.rb', line 90

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

  # The state of matching `LfpStore` to a Google Business Profile.
  module StoreMatchingState
    # Store matching state unspecified.
    STORE_MATCHING_STATE_UNSPECIFIED = 0

    # The `LfpStore` is successfully matched with a Google Business Profile
    # store.
    STORE_MATCHING_STATE_MATCHED = 1

    # The `LfpStore` is not matched with a Google Business Profile store.
    STORE_MATCHING_STATE_FAILED = 2
  end
end

#place_id ⇒ ::String

Returns Optional. The Google Place Id of the store location.

Returns:



90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
 
# File 'proto_docs/google/shopping/merchant/lfp/v1beta/lfpstore.rb', line 90

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

  # The state of matching `LfpStore` to a Google Business Profile.
  module StoreMatchingState
    # Store matching state unspecified.
    STORE_MATCHING_STATE_UNSPECIFIED = 0

    # The `LfpStore` is successfully matched with a Google Business Profile
    # store.
    STORE_MATCHING_STATE_MATCHED = 1

    # The `LfpStore` is not matched with a Google Business Profile store.
    STORE_MATCHING_STATE_FAILED = 2
  end
end

#store_address ⇒ ::String

Returns Required. The street address of the store. Example: 1600 Amphitheatre Pkwy, Mountain View, CA 94043, USA.

Returns:

  • (::String) —

    Required. The street address of the store. Example: 1600 Amphitheatre Pkwy, Mountain View, CA 94043, USA.



90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
 
# File 'proto_docs/google/shopping/merchant/lfp/v1beta/lfpstore.rb', line 90

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

  # The state of matching `LfpStore` to a Google Business Profile.
  module StoreMatchingState
    # Store matching state unspecified.
    STORE_MATCHING_STATE_UNSPECIFIED = 0

    # The `LfpStore` is successfully matched with a Google Business Profile
    # store.
    STORE_MATCHING_STATE_MATCHED = 1

    # The `LfpStore` is not matched with a Google Business Profile store.
    STORE_MATCHING_STATE_FAILED = 2
  end
end

#store_code ⇒ ::String

Returns Required. Immutable. A store identifier that is unique for the target merchant.

Returns:

  • (::String) —

    Required. Immutable. A store identifier that is unique for the target merchant.



90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
 
# File 'proto_docs/google/shopping/merchant/lfp/v1beta/lfpstore.rb', line 90

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

  # The state of matching `LfpStore` to a Google Business Profile.
  module StoreMatchingState
    # Store matching state unspecified.
    STORE_MATCHING_STATE_UNSPECIFIED = 0

    # The `LfpStore` is successfully matched with a Google Business Profile
    # store.
    STORE_MATCHING_STATE_MATCHED = 1

    # The `LfpStore` is not matched with a Google Business Profile store.
    STORE_MATCHING_STATE_FAILED = 2
  end
end

#store_name ⇒ ::String

Returns Optional. The merchant or store name.

Returns:

  • (::String) —

    Optional. The merchant or store name.



90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
 
# File 'proto_docs/google/shopping/merchant/lfp/v1beta/lfpstore.rb', line 90

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

  # The state of matching `LfpStore` to a Google Business Profile.
  module StoreMatchingState
    # Store matching state unspecified.
    STORE_MATCHING_STATE_UNSPECIFIED = 0

    # The `LfpStore` is successfully matched with a Google Business Profile
    # store.
    STORE_MATCHING_STATE_MATCHED = 1

    # The `LfpStore` is not matched with a Google Business Profile store.
    STORE_MATCHING_STATE_FAILED = 2
  end
end

#target_account ⇒ ::Integer

Returns Required. The Merchant Center id of the merchant to submit the store for.

Returns:

  • (::Integer) —

    Required. The Merchant Center id of the merchant to submit the store for.



90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
 
# File 'proto_docs/google/shopping/merchant/lfp/v1beta/lfpstore.rb', line 90

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

  # The state of matching `LfpStore` to a Google Business Profile.
  module StoreMatchingState
    # Store matching state unspecified.
    STORE_MATCHING_STATE_UNSPECIFIED = 0

    # The `LfpStore` is successfully matched with a Google Business Profile
    # store.
    STORE_MATCHING_STATE_MATCHED = 1

    # The `LfpStore` is not matched with a Google Business Profile store.
    STORE_MATCHING_STATE_FAILED = 2
  end
end

#website_uri ⇒ ::String

Returns Optional. The website URL for the store or merchant.

Returns:

  • (::String) —

    Optional. The website URL for the store or merchant.



90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
 
# File 'proto_docs/google/shopping/merchant/lfp/v1beta/lfpstore.rb', line 90

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

  # The state of matching `LfpStore` to a Google Business Profile.
  module StoreMatchingState
    # Store matching state unspecified.
    STORE_MATCHING_STATE_UNSPECIFIED = 0

    # The `LfpStore` is successfully matched with a Google Business Profile
    # store.
    STORE_MATCHING_STATE_MATCHED = 1

    # The `LfpStore` is not matched with a Google Business Profile store.
    STORE_MATCHING_STATE_FAILED = 2
  end
end