Package com.google.ads.googleads.v15.resources

Interface AudienceOrBuilder

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

    • Method Detail

      • getResourceName

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

      • getResourceNameBytes

        com.google.protobuf.ByteString getResourceNameBytes()
         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) = { ... }
        Returns:
        The bytes for resourceName.

      • getId

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

      • getStatusValue

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

      • getStatus

        AudienceStatusEnum.AudienceStatus getStatus()
         Output only. Status of this audience. Indicates whether the audience
 is enabled or removed.
        .google.ads.googleads.v15.enums.AudienceStatusEnum.AudienceStatus status = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        The status.

      • hasName

        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;
        Returns:
        Whether the name field is set.

      • getName

        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;
        Returns:
        The name.

      • getNameBytes

        com.google.protobuf.ByteString getNameBytes()
         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;
        Returns:
        The bytes for name.

      • getDescription

        java.lang.String getDescription()
         Description of this audience.
        string description = 5;
        Returns:
        The description.

      • getDescriptionBytes

        com.google.protobuf.ByteString getDescriptionBytes()
         Description of this audience.
        string description = 5;
        Returns:
        The bytes for description.

      • getDimensionsList

        java.util.List<AudienceDimension> getDimensionsList()
         Positive dimensions specifying the audience composition.
        repeated .google.ads.googleads.v15.common.AudienceDimension dimensions = 6;

      • getDimensions

        AudienceDimension getDimensions​(int index)
         Positive dimensions specifying the audience composition.
        repeated .google.ads.googleads.v15.common.AudienceDimension dimensions = 6;

      • getDimensionsCount

        int getDimensionsCount()
         Positive dimensions specifying the audience composition.
        repeated .google.ads.googleads.v15.common.AudienceDimension dimensions = 6;

      • getDimensionsOrBuilderList

        java.util.List<? extends AudienceDimensionOrBuilder> getDimensionsOrBuilderList()
         Positive dimensions specifying the audience composition.
        repeated .google.ads.googleads.v15.common.AudienceDimension dimensions = 6;

      • getDimensionsOrBuilder

        AudienceDimensionOrBuilder getDimensionsOrBuilder​(int index)
         Positive dimensions specifying the audience composition.
        repeated .google.ads.googleads.v15.common.AudienceDimension dimensions = 6;

      • hasExclusionDimension

        boolean hasExclusionDimension()
         Negative dimension specifying the audience composition.
        .google.ads.googleads.v15.common.AudienceExclusionDimension exclusion_dimension = 7;
        Returns:
        Whether the exclusionDimension field is set.

      • getExclusionDimension

        AudienceExclusionDimension getExclusionDimension()
         Negative dimension specifying the audience composition.
        .google.ads.googleads.v15.common.AudienceExclusionDimension exclusion_dimension = 7;
        Returns:
        The exclusionDimension.

      • getExclusionDimensionOrBuilder

        AudienceExclusionDimensionOrBuilder getExclusionDimensionOrBuilder()
         Negative dimension specifying the audience composition.
        .google.ads.googleads.v15.common.AudienceExclusionDimension exclusion_dimension = 7;

      • getScopeValue

        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.v15.enums.AudienceScopeEnum.AudienceScope scope = 8;
        Returns:
        The enum numeric value on the wire for scope.

      • getScope

        AudienceScopeEnum.AudienceScope getScope()
         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.v15.enums.AudienceScopeEnum.AudienceScope scope = 8;
        Returns:
        The scope.

      • getAssetGroup

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

      • getAssetGroupBytes

        com.google.protobuf.ByteString getAssetGroupBytes()
         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) = { ... }
        Returns:
        The bytes for assetGroup.