Package com.google.ads.googleads.v10.resources

Class ConversionValueRuleSet

  • All Implemented Interfaces:
    ConversionValueRuleSetOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, java.io.Serializable
    public final class ConversionValueRuleSet
extends com.google.protobuf.GeneratedMessageV3
implements ConversionValueRuleSetOrBuilder
     A conversion value rule set
    Protobuf type google.ads.googleads.v10.resources.ConversionValueRuleSet
    See Also:
    Serialized Form

    • Field Detail

      • RESOURCE_NAME_FIELD_NUMBER

        public static final int RESOURCE_NAME_FIELD_NUMBER
        See Also:
        Constant Field Values

      • CONVERSION_VALUE_RULES_FIELD_NUMBER

        public static final int CONVERSION_VALUE_RULES_FIELD_NUMBER
        See Also:
        Constant Field Values

      • DIMENSIONS_FIELD_NUMBER

        public static final int DIMENSIONS_FIELD_NUMBER
        See Also:
        Constant Field Values

      • OWNER_CUSTOMER_FIELD_NUMBER

        public static final int OWNER_CUSTOMER_FIELD_NUMBER
        See Also:
        Constant Field Values

      • ATTACHMENT_TYPE_FIELD_NUMBER

        public static final int ATTACHMENT_TYPE_FIELD_NUMBER
        See Also:
        Constant Field Values

      • CONVERSION_ACTION_CATEGORIES_FIELD_NUMBER

        public static final int CONVERSION_ACTION_CATEGORIES_FIELD_NUMBER
        See Also:
        Constant Field Values

    • Method Detail

      • newInstance

        protected java.lang.Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class com.google.protobuf.GeneratedMessageV3

      • getUnknownFields

        public final com.google.protobuf.UnknownFieldSet getUnknownFields()
        Specified by:
        getUnknownFields in interface com.google.protobuf.MessageOrBuilder
        Overrides:
        getUnknownFields in class com.google.protobuf.GeneratedMessageV3

      • getDescriptor

        public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

      • getResourceName

        public java.lang.String getResourceName()
         Immutable. The resource name of the conversion value rule set.
 Conversion value rule set resource names have the form:
 `customers/{customer_id}/conversionValueRuleSets/{conversion_value_rule_set_id}`
        string resource_name = 1 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { ... }
        Specified by:
        getResourceName in interface ConversionValueRuleSetOrBuilder
        Returns:
        The resourceName.

      • getResourceNameBytes

        public com.google.protobuf.ByteString getResourceNameBytes()
         Immutable. The resource name of the conversion value rule set.
 Conversion value rule set resource names have the form:
 `customers/{customer_id}/conversionValueRuleSets/{conversion_value_rule_set_id}`
        string resource_name = 1 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { ... }
        Specified by:
        getResourceNameBytes in interface ConversionValueRuleSetOrBuilder
        Returns:
        The bytes for resourceName.

      • getId

        public long getId()
         Output only. The ID of the conversion value rule set.
        int64 id = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getId in interface ConversionValueRuleSetOrBuilder
        Returns:
        The id.

      • getConversionValueRulesList

        public com.google.protobuf.ProtocolStringList getConversionValueRulesList()
         Resource names of rules within the rule set.
        repeated string conversion_value_rules = 3 [(.google.api.resource_reference) = { ... }
        Specified by:
        getConversionValueRulesList in interface ConversionValueRuleSetOrBuilder
        Returns:
        A list containing the conversionValueRules.

      • getConversionValueRulesCount

        public int getConversionValueRulesCount()
         Resource names of rules within the rule set.
        repeated string conversion_value_rules = 3 [(.google.api.resource_reference) = { ... }
        Specified by:
        getConversionValueRulesCount in interface ConversionValueRuleSetOrBuilder
        Returns:
        The count of conversionValueRules.

      • getConversionValueRules

        public java.lang.String getConversionValueRules​(int index)
         Resource names of rules within the rule set.
        repeated string conversion_value_rules = 3 [(.google.api.resource_reference) = { ... }
        Specified by:
        getConversionValueRules in interface ConversionValueRuleSetOrBuilder
        Parameters:
        index - The index of the element to return.
        Returns:
        The conversionValueRules at the given index.

      • getConversionValueRulesBytes

        public com.google.protobuf.ByteString getConversionValueRulesBytes​(int index)
         Resource names of rules within the rule set.
        repeated string conversion_value_rules = 3 [(.google.api.resource_reference) = { ... }
        Specified by:
        getConversionValueRulesBytes in interface ConversionValueRuleSetOrBuilder
        Parameters:
        index - The index of the value to return.
        Returns:
        The bytes of the conversionValueRules at the given index.

      • getDimensionsList

        public java.util.List<ValueRuleSetDimensionEnum.ValueRuleSetDimension> getDimensionsList()
         Defines dimensions for Value Rule conditions. The condition types of value
 rules within this value rule set must be of these dimensions. The first
 entry in this list is the primary dimension of the included value rules.
 When using value rule primary dimension segmentation, conversion values
 will be segmented into the values adjusted by value rules and the original
 values, if some value rules apply.
        repeated .google.ads.googleads.v10.enums.ValueRuleSetDimensionEnum.ValueRuleSetDimension dimensions = 4;
        Specified by:
        getDimensionsList in interface ConversionValueRuleSetOrBuilder
        Returns:
        A list containing the dimensions.

      • getDimensionsCount

        public int getDimensionsCount()
         Defines dimensions for Value Rule conditions. The condition types of value
 rules within this value rule set must be of these dimensions. The first
 entry in this list is the primary dimension of the included value rules.
 When using value rule primary dimension segmentation, conversion values
 will be segmented into the values adjusted by value rules and the original
 values, if some value rules apply.
        repeated .google.ads.googleads.v10.enums.ValueRuleSetDimensionEnum.ValueRuleSetDimension dimensions = 4;
        Specified by:
        getDimensionsCount in interface ConversionValueRuleSetOrBuilder
        Returns:
        The count of dimensions.

      • getDimensions

        public ValueRuleSetDimensionEnum.ValueRuleSetDimension getDimensions​(int index)
         Defines dimensions for Value Rule conditions. The condition types of value
 rules within this value rule set must be of these dimensions. The first
 entry in this list is the primary dimension of the included value rules.
 When using value rule primary dimension segmentation, conversion values
 will be segmented into the values adjusted by value rules and the original
 values, if some value rules apply.
        repeated .google.ads.googleads.v10.enums.ValueRuleSetDimensionEnum.ValueRuleSetDimension dimensions = 4;
        Specified by:
        getDimensions in interface ConversionValueRuleSetOrBuilder
        Parameters:
        index - The index of the element to return.
        Returns:
        The dimensions at the given index.

      • getDimensionsValueList

        public java.util.List<java.lang.Integer> getDimensionsValueList()
         Defines dimensions for Value Rule conditions. The condition types of value
 rules within this value rule set must be of these dimensions. The first
 entry in this list is the primary dimension of the included value rules.
 When using value rule primary dimension segmentation, conversion values
 will be segmented into the values adjusted by value rules and the original
 values, if some value rules apply.
        repeated .google.ads.googleads.v10.enums.ValueRuleSetDimensionEnum.ValueRuleSetDimension dimensions = 4;
        Specified by:
        getDimensionsValueList in interface ConversionValueRuleSetOrBuilder
        Returns:
        A list containing the enum numeric values on the wire for dimensions.

      • getDimensionsValue

        public int getDimensionsValue​(int index)
         Defines dimensions for Value Rule conditions. The condition types of value
 rules within this value rule set must be of these dimensions. The first
 entry in this list is the primary dimension of the included value rules.
 When using value rule primary dimension segmentation, conversion values
 will be segmented into the values adjusted by value rules and the original
 values, if some value rules apply.
        repeated .google.ads.googleads.v10.enums.ValueRuleSetDimensionEnum.ValueRuleSetDimension dimensions = 4;
        Specified by:
        getDimensionsValue in interface ConversionValueRuleSetOrBuilder
        Parameters:
        index - The index of the value to return.
        Returns:
        The enum numeric value on the wire of dimensions at the given index.

      • getOwnerCustomer

        public java.lang.String getOwnerCustomer()
         Output only. The resource name of the conversion value rule set's owner customer.
 When the value rule set is inherited from a manager
 customer, owner_customer will be the resource name of the manager whereas
 the customer in the resource_name will be of the requesting serving
 customer.
 ** Read-only **
        string owner_customer = 5 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
        Specified by:
        getOwnerCustomer in interface ConversionValueRuleSetOrBuilder
        Returns:
        The ownerCustomer.

      • getOwnerCustomerBytes

        public com.google.protobuf.ByteString getOwnerCustomerBytes()
         Output only. The resource name of the conversion value rule set's owner customer.
 When the value rule set is inherited from a manager
 customer, owner_customer will be the resource name of the manager whereas
 the customer in the resource_name will be of the requesting serving
 customer.
 ** Read-only **
        string owner_customer = 5 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
        Specified by:
        getOwnerCustomerBytes in interface ConversionValueRuleSetOrBuilder
        Returns:
        The bytes for ownerCustomer.

      • getAttachmentTypeValue

        public int getAttachmentTypeValue()
         Immutable. Defines the scope where the conversion value rule set is attached.
        .google.ads.googleads.v10.enums.ValueRuleSetAttachmentTypeEnum.ValueRuleSetAttachmentType attachment_type = 6 [(.google.api.field_behavior) = IMMUTABLE];
        Specified by:
        getAttachmentTypeValue in interface ConversionValueRuleSetOrBuilder
        Returns:
        The enum numeric value on the wire for attachmentType.

      • getCampaign

        public java.lang.String getCampaign()
         The resource name of the campaign when the conversion value rule
 set is attached to a campaign.
        string campaign = 7 [(.google.api.resource_reference) = { ... }
        Specified by:
        getCampaign in interface ConversionValueRuleSetOrBuilder
        Returns:
        The campaign.

      • getCampaignBytes

        public com.google.protobuf.ByteString getCampaignBytes()
         The resource name of the campaign when the conversion value rule
 set is attached to a campaign.
        string campaign = 7 [(.google.api.resource_reference) = { ... }
        Specified by:
        getCampaignBytes in interface ConversionValueRuleSetOrBuilder
        Returns:
        The bytes for campaign.

      • getStatusValue

        public int getStatusValue()
         Output only. The status of the conversion value rule set.
 ** Read-only **
        .google.ads.googleads.v10.enums.ConversionValueRuleSetStatusEnum.ConversionValueRuleSetStatus status = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getStatusValue in interface ConversionValueRuleSetOrBuilder
        Returns:
        The enum numeric value on the wire for status.

      • getConversionActionCategoriesCount

        public int getConversionActionCategoriesCount()
         Immutable. The conversion action categories of the conversion value rule set.
        repeated .google.ads.googleads.v10.enums.ConversionActionCategoryEnum.ConversionActionCategory conversion_action_categories = 9 [(.google.api.field_behavior) = IMMUTABLE];
        Specified by:
        getConversionActionCategoriesCount in interface ConversionValueRuleSetOrBuilder
        Returns:
        The count of conversionActionCategories.

      • getConversionActionCategories

        public ConversionActionCategoryEnum.ConversionActionCategory getConversionActionCategories​(int index)
         Immutable. The conversion action categories of the conversion value rule set.
        repeated .google.ads.googleads.v10.enums.ConversionActionCategoryEnum.ConversionActionCategory conversion_action_categories = 9 [(.google.api.field_behavior) = IMMUTABLE];
        Specified by:
        getConversionActionCategories in interface ConversionValueRuleSetOrBuilder
        Parameters:
        index - The index of the element to return.
        Returns:
        The conversionActionCategories at the given index.

      • getConversionActionCategoriesValueList

        public java.util.List<java.lang.Integer> getConversionActionCategoriesValueList()
         Immutable. The conversion action categories of the conversion value rule set.
        repeated .google.ads.googleads.v10.enums.ConversionActionCategoryEnum.ConversionActionCategory conversion_action_categories = 9 [(.google.api.field_behavior) = IMMUTABLE];
        Specified by:
        getConversionActionCategoriesValueList in interface ConversionValueRuleSetOrBuilder
        Returns:
        A list containing the enum numeric values on the wire for conversionActionCategories.

      • getConversionActionCategoriesValue

        public int getConversionActionCategoriesValue​(int index)
         Immutable. The conversion action categories of the conversion value rule set.
        repeated .google.ads.googleads.v10.enums.ConversionActionCategoryEnum.ConversionActionCategory conversion_action_categories = 9 [(.google.api.field_behavior) = IMMUTABLE];
        Specified by:
        getConversionActionCategoriesValue in interface ConversionValueRuleSetOrBuilder
        Parameters:
        index - The index of the value to return.
        Returns:
        The enum numeric value on the wire of conversionActionCategories at the given index.

      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3

      • writeTo

        public void writeTo​(com.google.protobuf.CodedOutputStream output)
             throws java.io.IOException
        Specified by:
        writeTo in interface com.google.protobuf.MessageLite
        Overrides:
        writeTo in class com.google.protobuf.GeneratedMessageV3
        Throws:
        java.io.IOException

      • getSerializedSize

        public int getSerializedSize()
        Specified by:
        getSerializedSize in interface com.google.protobuf.MessageLite
        Overrides:
        getSerializedSize in class com.google.protobuf.GeneratedMessageV3

      • equals

        public boolean equals​(java.lang.Object obj)
        Specified by:
        equals in interface com.google.protobuf.Message
        Overrides:
        equals in class com.google.protobuf.AbstractMessage

      • hashCode

        public int hashCode()
        Specified by:
        hashCode in interface com.google.protobuf.Message
        Overrides:
        hashCode in class com.google.protobuf.AbstractMessage

      • parseFrom

        public static ConversionValueRuleSet parseFrom​(java.nio.ByteBuffer data)
                                        throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static ConversionValueRuleSet parseFrom​(java.nio.ByteBuffer data,
                                               com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                        throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static ConversionValueRuleSet parseFrom​(com.google.protobuf.ByteString data)
                                        throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static ConversionValueRuleSet parseFrom​(com.google.protobuf.ByteString data,
                                               com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                        throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static ConversionValueRuleSet parseFrom​(byte[] data)
                                        throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static ConversionValueRuleSet parseFrom​(byte[] data,
                                               com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                        throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static ConversionValueRuleSet parseFrom​(java.io.InputStream input)
                                        throws java.io.IOException
        Throws:
        java.io.IOException

      • parseFrom

        public static ConversionValueRuleSet parseFrom​(java.io.InputStream input,
                                               com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                        throws java.io.IOException
        Throws:
        java.io.IOException

      • parseDelimitedFrom

        public static ConversionValueRuleSet parseDelimitedFrom​(java.io.InputStream input)
                                                 throws java.io.IOException
        Throws:
        java.io.IOException

      • parseDelimitedFrom

        public static ConversionValueRuleSet parseDelimitedFrom​(java.io.InputStream input,
                                                        com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                 throws java.io.IOException
        Throws:
        java.io.IOException

      • parseFrom

        public static ConversionValueRuleSet parseFrom​(com.google.protobuf.CodedInputStream input)
                                        throws java.io.IOException
        Throws:
        java.io.IOException

      • parseFrom

        public static ConversionValueRuleSet parseFrom​(com.google.protobuf.CodedInputStream input,
                                               com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                        throws java.io.IOException
        Throws:
        java.io.IOException

      • newBuilderForType

        public ConversionValueRuleSet.Builder newBuilderForType()
        Specified by:
        newBuilderForType in interface com.google.protobuf.Message
        Specified by:
        newBuilderForType in interface com.google.protobuf.MessageLite

      • toBuilder

        public ConversionValueRuleSet.Builder toBuilder()
        Specified by:
        toBuilder in interface com.google.protobuf.Message
        Specified by:
        toBuilder in interface com.google.protobuf.MessageLite

      • newBuilderForType

        protected ConversionValueRuleSet.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3

      • getParserForType

        public com.google.protobuf.Parser<ConversionValueRuleSet> getParserForType()
        Specified by:
        getParserForType in interface com.google.protobuf.Message
        Specified by:
        getParserForType in interface com.google.protobuf.MessageLite
        Overrides:
        getParserForType in class com.google.protobuf.GeneratedMessageV3

      • getDefaultInstanceForType

        public ConversionValueRuleSet getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder