com.google.ads.googleads.v17.resources.ConversionValueRuleSetOrBuilder Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of google-ads-stubs-v17 Show documentation
Stubs for GAAPI version google-ads-stubs-v17
The newest version!
// Generated by the protocol buffer compiler.  DO NOT EDIT!
// source: google/ads/googleads/v17/resources/conversion_value_rule_set.proto

// Protobuf Java Version: 3.25.3
package com.google.ads.googleads.v17.resources;

public interface ConversionValueRuleSetOrBuilder extends
    // @@protoc_insertion_point(interface_extends:google.ads.googleads.v17.resources.ConversionValueRuleSet)
    com.google.protobuf.MessageOrBuilder {

  /**
   *    * 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) = { ... }
   * @return The resourceName.
   */
  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) = { ... }
   * @return The bytes for resourceName.
   */
  com.google.protobuf.ByteString
      getResourceNameBytes();

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

  /**
   *    * Resource names of rules within the rule set.
   * 
   *
   * repeated string conversion_value_rules = 3 [(.google.api.resource_reference) = { ... }
   * @return A list containing the conversionValueRules.
   */
  java.util.List
      getConversionValueRulesList();
  /**
   *    * Resource names of rules within the rule set.
   * 
   *
   * repeated string conversion_value_rules = 3 [(.google.api.resource_reference) = { ... }
   * @return The count of conversionValueRules.
   */
  int getConversionValueRulesCount();
  /**
   *    * Resource names of rules within the rule set.
   * 
   *
   * repeated string conversion_value_rules = 3 [(.google.api.resource_reference) = { ... }
   * @param index The index of the element to return.
   * @return The conversionValueRules at the given index.
   */
  java.lang.String getConversionValueRules(int index);
  /**
   *    * Resource names of rules within the rule set.
   * 
   *
   * repeated string conversion_value_rules = 3 [(.google.api.resource_reference) = { ... }
   * @param index The index of the value to return.
   * @return The bytes of the conversionValueRules at the given index.
   */
  com.google.protobuf.ByteString
      getConversionValueRulesBytes(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.v17.enums.ValueRuleSetDimensionEnum.ValueRuleSetDimension dimensions = 4;
   * @return A list containing the dimensions.
   */
  java.util.List 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.v17.enums.ValueRuleSetDimensionEnum.ValueRuleSetDimension dimensions = 4;
   * @return The count of dimensions.
   */
  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.v17.enums.ValueRuleSetDimensionEnum.ValueRuleSetDimension dimensions = 4;
   * @param index The index of the element to return.
   * @return The dimensions at the given index.
   */
  com.google.ads.googleads.v17.enums.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.v17.enums.ValueRuleSetDimensionEnum.ValueRuleSetDimension dimensions = 4;
   * @return A list containing the enum numeric values on the wire for dimensions.
   */
  java.util.List
  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.v17.enums.ValueRuleSetDimensionEnum.ValueRuleSetDimension dimensions = 4;
   * @param index The index of the value to return.
   * @return The enum numeric value on the wire of dimensions at the given index.
   */
  int getDimensionsValue(int index);

  /**
   *    * 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) = { ... }
   * @return The ownerCustomer.
   */
  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) = { ... }
   * @return The bytes for ownerCustomer.
   */
  com.google.protobuf.ByteString
      getOwnerCustomerBytes();

  /**
   *    * Immutable. Defines the scope where the conversion value rule set is
   * attached.
   * 
   *
   * .google.ads.googleads.v17.enums.ValueRuleSetAttachmentTypeEnum.ValueRuleSetAttachmentType attachment_type = 6 [(.google.api.field_behavior) = IMMUTABLE];
   * @return The enum numeric value on the wire for attachmentType.
   */
  int getAttachmentTypeValue();
  /**
   *    * Immutable. Defines the scope where the conversion value rule set is
   * attached.
   * 
   *
   * .google.ads.googleads.v17.enums.ValueRuleSetAttachmentTypeEnum.ValueRuleSetAttachmentType attachment_type = 6 [(.google.api.field_behavior) = IMMUTABLE];
   * @return The attachmentType.
   */
  com.google.ads.googleads.v17.enums.ValueRuleSetAttachmentTypeEnum.ValueRuleSetAttachmentType getAttachmentType();

  /**
   *    * The resource name of the campaign when the conversion value rule
   * set is attached to a campaign.
   * 
   *
   * string campaign = 7 [(.google.api.resource_reference) = { ... }
   * @return The campaign.
   */
  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) = { ... }
   * @return The bytes for campaign.
   */
  com.google.protobuf.ByteString
      getCampaignBytes();

  /**
   *    * Output only. The status of the conversion value rule set.
   * ** Read-only **
   * 
   *
   * .google.ads.googleads.v17.enums.ConversionValueRuleSetStatusEnum.ConversionValueRuleSetStatus status = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
   * @return The enum numeric value on the wire for status.
   */
  int getStatusValue();
  /**
   *    * Output only. The status of the conversion value rule set.
   * ** Read-only **
   * 
   *
   * .google.ads.googleads.v17.enums.ConversionValueRuleSetStatusEnum.ConversionValueRuleSetStatus status = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
   * @return The status.
   */
  com.google.ads.googleads.v17.enums.ConversionValueRuleSetStatusEnum.ConversionValueRuleSetStatus getStatus();

  /**
   *    * Immutable. The conversion action categories of the conversion value rule
   * set.
   * 
   *
   * repeated .google.ads.googleads.v17.enums.ConversionActionCategoryEnum.ConversionActionCategory conversion_action_categories = 9 [(.google.api.field_behavior) = IMMUTABLE];
   * @return A list containing the conversionActionCategories.
   */
  java.util.List getConversionActionCategoriesList();
  /**
   *    * Immutable. The conversion action categories of the conversion value rule
   * set.
   * 
   *
   * repeated .google.ads.googleads.v17.enums.ConversionActionCategoryEnum.ConversionActionCategory conversion_action_categories = 9 [(.google.api.field_behavior) = IMMUTABLE];
   * @return The count of conversionActionCategories.
   */
  int getConversionActionCategoriesCount();
  /**
   *    * Immutable. The conversion action categories of the conversion value rule
   * set.
   * 
   *
   * repeated .google.ads.googleads.v17.enums.ConversionActionCategoryEnum.ConversionActionCategory conversion_action_categories = 9 [(.google.api.field_behavior) = IMMUTABLE];
   * @param index The index of the element to return.
   * @return The conversionActionCategories at the given index.
   */
  com.google.ads.googleads.v17.enums.ConversionActionCategoryEnum.ConversionActionCategory getConversionActionCategories(int index);
  /**
   *    * Immutable. The conversion action categories of the conversion value rule
   * set.
   * 
   *
   * repeated .google.ads.googleads.v17.enums.ConversionActionCategoryEnum.ConversionActionCategory conversion_action_categories = 9 [(.google.api.field_behavior) = IMMUTABLE];
   * @return A list containing the enum numeric values on the wire for conversionActionCategories.
   */
  java.util.List
  getConversionActionCategoriesValueList();
  /**
   *    * Immutable. The conversion action categories of the conversion value rule
   * set.
   * 
   *
   * repeated .google.ads.googleads.v17.enums.ConversionActionCategoryEnum.ConversionActionCategory conversion_action_categories = 9 [(.google.api.field_behavior) = IMMUTABLE];
   * @param index The index of the value to return.
   * @return The enum numeric value on the wire of conversionActionCategories at the given index.
   */
  int getConversionActionCategoriesValue(int index);
}