Class: Google::Shopping::Merchant::Conversions::V1beta::ConversionSource

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/shopping/merchant/conversions/v1beta/conversionsources.rb

Overview

Represents a conversion source owned by a Merchant account. A merchant account can have up to 200 conversion sources.

Defined Under Namespace

Modules: Controller, State

Instance Attribute Summary collapse

Instance Attribute Details

#controller ⇒ ::Google::Shopping::Merchant::Conversions::V1beta::ConversionSource::Controller (readonly)

Returns Output only. Controller of the conversion source.

Returns:



58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
 
# File 'proto_docs/google/shopping/merchant/conversions/v1beta/conversionsources.rb', line 58

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

  # Represents state of the conversion source.
  module State
    # Conversion source has unspecified state.
    STATE_UNSPECIFIED = 0

    # Conversion source is fully functional.
    ACTIVE = 1

    # Conversion source has been archived in the last 30 days and not
    # currently functional. Can be restored using the undelete method.
    ARCHIVED = 2

    # Conversion source creation has started but not fully finished yet.
    PENDING = 3
  end

  # Entity controlling the conversion source.
  module Controller
    # Default value. This value is unused.
    CONTROLLER_UNSPECIFIED = 0

    # Controlled by the Merchant who owns the Conversion Source.
    MERCHANT = 1

    # Controlled by the YT Affiliates program.
    YOUTUBE_AFFILIATES = 2
  end
end

#expire_time ⇒ ::Google::Protobuf::Timestamp (readonly)

Returns Output only. The time when an archived conversion source becomes permanently deleted and is no longer available to undelete.

Returns:

  • (::Google::Protobuf::Timestamp) —

    Output only. The time when an archived conversion source becomes permanently deleted and is no longer available to undelete.



58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
 
# File 'proto_docs/google/shopping/merchant/conversions/v1beta/conversionsources.rb', line 58

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

  # Represents state of the conversion source.
  module State
    # Conversion source has unspecified state.
    STATE_UNSPECIFIED = 0

    # Conversion source is fully functional.
    ACTIVE = 1

    # Conversion source has been archived in the last 30 days and not
    # currently functional. Can be restored using the undelete method.
    ARCHIVED = 2

    # Conversion source creation has started but not fully finished yet.
    PENDING = 3
  end

  # Entity controlling the conversion source.
  module Controller
    # Default value. This value is unused.
    CONTROLLER_UNSPECIFIED = 0

    # Controlled by the Merchant who owns the Conversion Source.
    MERCHANT = 1

    # Controlled by the YT Affiliates program.
    YOUTUBE_AFFILIATES = 2
  end
end

#google_analytics_link ⇒ ::Google::Shopping::Merchant::Conversions::V1beta::GoogleAnalyticsLink

Returns Immutable. Conversion Source of type "Link to Google Analytics Property".

Note: The following fields are mutually exclusive: google_analytics_link, merchant_center_destination. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns:

  • (::Google::Shopping::Merchant::Conversions::V1beta::GoogleAnalyticsLink) —

    Immutable. Conversion Source of type "Link to Google Analytics Property".

    Note: The following fields are mutually exclusive: google_analytics_link, merchant_center_destination. If a field in that set is populated, all other fields in the set will automatically be cleared.



58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
 
# File 'proto_docs/google/shopping/merchant/conversions/v1beta/conversionsources.rb', line 58

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

  # Represents state of the conversion source.
  module State
    # Conversion source has unspecified state.
    STATE_UNSPECIFIED = 0

    # Conversion source is fully functional.
    ACTIVE = 1

    # Conversion source has been archived in the last 30 days and not
    # currently functional. Can be restored using the undelete method.
    ARCHIVED = 2

    # Conversion source creation has started but not fully finished yet.
    PENDING = 3
  end

  # Entity controlling the conversion source.
  module Controller
    # Default value. This value is unused.
    CONTROLLER_UNSPECIFIED = 0

    # Controlled by the Merchant who owns the Conversion Source.
    MERCHANT = 1

    # Controlled by the YT Affiliates program.
    YOUTUBE_AFFILIATES = 2
  end
end

#merchant_center_destination ⇒ ::Google::Shopping::Merchant::Conversions::V1beta::MerchantCenterDestination

Returns Conversion Source of type "Merchant Center Tag Destination".

Note: The following fields are mutually exclusive: merchant_center_destination, google_analytics_link. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns:



58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
 
# File 'proto_docs/google/shopping/merchant/conversions/v1beta/conversionsources.rb', line 58

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

  # Represents state of the conversion source.
  module State
    # Conversion source has unspecified state.
    STATE_UNSPECIFIED = 0

    # Conversion source is fully functional.
    ACTIVE = 1

    # Conversion source has been archived in the last 30 days and not
    # currently functional. Can be restored using the undelete method.
    ARCHIVED = 2

    # Conversion source creation has started but not fully finished yet.
    PENDING = 3
  end

  # Entity controlling the conversion source.
  module Controller
    # Default value. This value is unused.
    CONTROLLER_UNSPECIFIED = 0

    # Controlled by the Merchant who owns the Conversion Source.
    MERCHANT = 1

    # Controlled by the YT Affiliates program.
    YOUTUBE_AFFILIATES = 2
  end
end

#name ⇒ ::String (readonly)

Returns Output only. Identifier. Generated by the Content API upon creation of a new ConversionSource. Format: [a-z]{4}:.+ The four characters before the colon represent the type of conversio source. Content after the colon represents the ID of the conversion source within that type. The ID of two different conversion sources might be the same across different types. The following type prefixes are supported:

  • galk: For GoogleAnalyticsLink sources.
  • mcdn: For MerchantCenterDestination sources.

Returns:

  • (::String) —

    Output only. Identifier. Generated by the Content API upon creation of a new ConversionSource. Format: [a-z]{4}:.+ The four characters before the colon represent the type of conversio source. Content after the colon represents the ID of the conversion source within that type. The ID of two different conversion sources might be the same across different types. The following type prefixes are supported:

    • galk: For GoogleAnalyticsLink sources.
    • mcdn: For MerchantCenterDestination sources.


58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
 
# File 'proto_docs/google/shopping/merchant/conversions/v1beta/conversionsources.rb', line 58

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

  # Represents state of the conversion source.
  module State
    # Conversion source has unspecified state.
    STATE_UNSPECIFIED = 0

    # Conversion source is fully functional.
    ACTIVE = 1

    # Conversion source has been archived in the last 30 days and not
    # currently functional. Can be restored using the undelete method.
    ARCHIVED = 2

    # Conversion source creation has started but not fully finished yet.
    PENDING = 3
  end

  # Entity controlling the conversion source.
  module Controller
    # Default value. This value is unused.
    CONTROLLER_UNSPECIFIED = 0

    # Controlled by the Merchant who owns the Conversion Source.
    MERCHANT = 1

    # Controlled by the YT Affiliates program.
    YOUTUBE_AFFILIATES = 2
  end
end

#state ⇒ ::Google::Shopping::Merchant::Conversions::V1beta::ConversionSource::State (readonly)

Returns Output only. Current state of this conversion source. Can't be edited through the API.

Returns:



58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
 
# File 'proto_docs/google/shopping/merchant/conversions/v1beta/conversionsources.rb', line 58

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

  # Represents state of the conversion source.
  module State
    # Conversion source has unspecified state.
    STATE_UNSPECIFIED = 0

    # Conversion source is fully functional.
    ACTIVE = 1

    # Conversion source has been archived in the last 30 days and not
    # currently functional. Can be restored using the undelete method.
    ARCHIVED = 2

    # Conversion source creation has started but not fully finished yet.
    PENDING = 3
  end

  # Entity controlling the conversion source.
  module Controller
    # Default value. This value is unused.
    CONTROLLER_UNSPECIFIED = 0

    # Controlled by the Merchant who owns the Conversion Source.
    MERCHANT = 1

    # Controlled by the YT Affiliates program.
    YOUTUBE_AFFILIATES = 2
  end
end