com.google.ads.googleads.v17.resources.AudienceOrBuilder 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/audience.proto

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

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

  /**
   *    * Immutable. The resource name of the audience.
   * Audience names have the form:
   *
   * `customers/{customer_id}/audiences/{audience_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 audience.
   * Audience names have the form:
   *
   * `customers/{customer_id}/audiences/{audience_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. ID of the audience.
   * 
   *
   * int64 id = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
   * @return The id.
   */
  long getId();

  /**
   *    * Output only. Status of this audience. Indicates whether the audience
   * is enabled or removed.
   * 
   *
   * .google.ads.googleads.v17.enums.AudienceStatusEnum.AudienceStatus status = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
   * @return The enum numeric value on the wire for status.
   */
  int getStatusValue();
  /**
   *    * Output only. Status of this audience. Indicates whether the audience
   * is enabled or removed.
   * 
   *
   * .google.ads.googleads.v17.enums.AudienceStatusEnum.AudienceStatus status = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
   * @return The status.
   */
  com.google.ads.googleads.v17.enums.AudienceStatusEnum.AudienceStatus getStatus();

  /**
   *    * Name of the audience. It should be unique across all audiences within the
   * account. It must have a minimum length of 1 and maximum length of 255.
   * Required when scope is not set or is set to CUSTOMER. Cannot be set or
   * updated when scope is ASSET_GROUP.
   * 
   *
   * optional string name = 10;
   * @return Whether the name field is set.
   */
  boolean hasName();
  /**
   *    * Name of the audience. It should be unique across all audiences within the
   * account. It must have a minimum length of 1 and maximum length of 255.
   * Required when scope is not set or is set to CUSTOMER. Cannot be set or
   * updated when scope is ASSET_GROUP.
   * 
   *
   * optional string name = 10;
   * @return The name.
   */
  java.lang.String getName();
  /**
   *    * Name of the audience. It should be unique across all audiences within the
   * account. It must have a minimum length of 1 and maximum length of 255.
   * Required when scope is not set or is set to CUSTOMER. Cannot be set or
   * updated when scope is ASSET_GROUP.
   * 
   *
   * optional string name = 10;
   * @return The bytes for name.
   */
  com.google.protobuf.ByteString
      getNameBytes();

  /**
   *    * Description of this audience.
   * 
   *
   * string description = 5;
   * @return The description.
   */
  java.lang.String getDescription();
  /**
   *    * Description of this audience.
   * 
   *
   * string description = 5;
   * @return The bytes for description.
   */
  com.google.protobuf.ByteString
      getDescriptionBytes();

  /**
   *    * Positive dimensions specifying the audience composition.
   * 
   *
   * repeated .google.ads.googleads.v17.common.AudienceDimension dimensions = 6;
   */
  java.util.List 
      getDimensionsList();
  /**
   *    * Positive dimensions specifying the audience composition.
   * 
   *
   * repeated .google.ads.googleads.v17.common.AudienceDimension dimensions = 6;
   */
  com.google.ads.googleads.v17.common.AudienceDimension getDimensions(int index);
  /**
   *    * Positive dimensions specifying the audience composition.
   * 
   *
   * repeated .google.ads.googleads.v17.common.AudienceDimension dimensions = 6;
   */
  int getDimensionsCount();
  /**
   *    * Positive dimensions specifying the audience composition.
   * 
   *
   * repeated .google.ads.googleads.v17.common.AudienceDimension dimensions = 6;
   */
  java.util.List 
      getDimensionsOrBuilderList();
  /**
   *    * Positive dimensions specifying the audience composition.
   * 
   *
   * repeated .google.ads.googleads.v17.common.AudienceDimension dimensions = 6;
   */
  com.google.ads.googleads.v17.common.AudienceDimensionOrBuilder getDimensionsOrBuilder(
      int index);

  /**
   *    * Negative dimension specifying the audience composition.
   * 
   *
   * .google.ads.googleads.v17.common.AudienceExclusionDimension exclusion_dimension = 7;
   * @return Whether the exclusionDimension field is set.
   */
  boolean hasExclusionDimension();
  /**
   *    * Negative dimension specifying the audience composition.
   * 
   *
   * .google.ads.googleads.v17.common.AudienceExclusionDimension exclusion_dimension = 7;
   * @return The exclusionDimension.
   */
  com.google.ads.googleads.v17.common.AudienceExclusionDimension getExclusionDimension();
  /**
   *    * Negative dimension specifying the audience composition.
   * 
   *
   * .google.ads.googleads.v17.common.AudienceExclusionDimension exclusion_dimension = 7;
   */
  com.google.ads.googleads.v17.common.AudienceExclusionDimensionOrBuilder getExclusionDimensionOrBuilder();

  /**
   *    * Defines the scope this audience can be used in. By default, the scope is
   * CUSTOMER. Audiences can be created with a scope of ASSET_GROUP for
   * exclusive use by a single asset_group. Scope may change from ASSET_GROUP to
   * CUSTOMER but not from CUSTOMER to ASSET_GROUP.
   * 
   *
   * .google.ads.googleads.v17.enums.AudienceScopeEnum.AudienceScope scope = 8;
   * @return The enum numeric value on the wire for scope.
   */
  int getScopeValue();
  /**
   *    * Defines the scope this audience can be used in. By default, the scope is
   * CUSTOMER. Audiences can be created with a scope of ASSET_GROUP for
   * exclusive use by a single asset_group. Scope may change from ASSET_GROUP to
   * CUSTOMER but not from CUSTOMER to ASSET_GROUP.
   * 
   *
   * .google.ads.googleads.v17.enums.AudienceScopeEnum.AudienceScope scope = 8;
   * @return The scope.
   */
  com.google.ads.googleads.v17.enums.AudienceScopeEnum.AudienceScope getScope();

  /**
   *    * Immutable. The asset group that this audience is scoped under. Must be set
   * if and only if scope is ASSET_GROUP. Immutable after creation. If an
   * audience with ASSET_GROUP scope is upgraded to CUSTOMER scope, this field
   * will automatically be cleared.
   * 
   *
   * string asset_group = 9 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { ... }
   * @return The assetGroup.
   */
  java.lang.String getAssetGroup();
  /**
   *    * Immutable. The asset group that this audience is scoped under. Must be set
   * if and only if scope is ASSET_GROUP. Immutable after creation. If an
   * audience with ASSET_GROUP scope is upgraded to CUSTOMER scope, this field
   * will automatically be cleared.
   * 
   *
   * string asset_group = 9 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { ... }
   * @return The bytes for assetGroup.
   */
  com.google.protobuf.ByteString
      getAssetGroupBytes();
}