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

Interface ConversionValueRuleSetOrBuilder

  • All Superinterfaces:
    com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
    All Known Implementing Classes:
    ConversionValueRuleSet, ConversionValueRuleSet.Builder
    public interface ConversionValueRuleSetOrBuilder
extends com.google.protobuf.MessageOrBuilder

    • Method Detail

      • getResourceName

        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) = { ... }
        Returns:
        The resourceName.

      • getResourceNameBytes

        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) = { ... }
        Returns:
        The bytes for resourceName.

      • getId

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

      • getConversionValueRulesList

        java.util.List<java.lang.String> getConversionValueRulesList()
         Resource names of rules within the rule set.
        repeated string conversion_value_rules = 3 [(.google.api.resource_reference) = { ... }
        Returns:
        A list containing the conversionValueRules.

      • getConversionValueRulesCount

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

      • getConversionValueRules

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

      • getConversionValueRulesBytes

        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) = { ... }
        Parameters:
        index - The index of the value to return.
        Returns:
        The bytes of the conversionValueRules at the given index.

      • getDimensionsList

        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;
        Returns:
        A list containing the dimensions.

      • getDimensionsCount

        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;
        Returns:
        The count of dimensions.

      • getDimensions

        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;
        Parameters:
        index - The index of the element to return.
        Returns:
        The dimensions at the given index.

      • getDimensionsValueList

        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;
        Returns:
        A list containing the enum numeric values on the wire for dimensions.

      • getDimensionsValue

        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;
        Parameters:
        index - The index of the value to return.
        Returns:
        The enum numeric value on the wire of dimensions at the given index.

      • getOwnerCustomer

        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) = { ... }
        Returns:
        The ownerCustomer.

      • getOwnerCustomerBytes

        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) = { ... }
        Returns:
        The bytes for ownerCustomer.

      • getAttachmentTypeValue

        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];
        Returns:
        The enum numeric value on the wire for attachmentType.

      • getAttachmentType

        ValueRuleSetAttachmentTypeEnum.ValueRuleSetAttachmentType getAttachmentType()
         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];
        Returns:
        The attachmentType.

      • getCampaign

        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) = { ... }
        Returns:
        The campaign.

      • getCampaignBytes

        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) = { ... }
        Returns:
        The bytes for campaign.

      • getStatusValue

        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];
        Returns:
        The enum numeric value on the wire for status.

      • getStatus

        ConversionValueRuleSetStatusEnum.ConversionValueRuleSetStatus getStatus()
         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];
        Returns:
        The status.

      • getConversionActionCategoriesList

        java.util.List<ConversionActionCategoryEnum.ConversionActionCategory> getConversionActionCategoriesList()
         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];
        Returns:
        A list containing the conversionActionCategories.

      • getConversionActionCategoriesCount

        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];
        Returns:
        The count of conversionActionCategories.

      • getConversionActionCategories

        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];
        Parameters:
        index - The index of the element to return.
        Returns:
        The conversionActionCategories at the given index.

      • getConversionActionCategoriesValueList

        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];
        Returns:
        A list containing the enum numeric values on the wire for conversionActionCategories.

      • getConversionActionCategoriesValue

        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];
        Parameters:
        index - The index of the value to return.
        Returns:
        The enum numeric value on the wire of conversionActionCategories at the given index.