Package com.google.ads.googleads.v18.resources

Class Audience

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
com.google.ads.googleads.v18.resources.Audience
All Implemented Interfaces:
AudienceOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
public final class Audience extends com.google.protobuf.GeneratedMessageV3 implements AudienceOrBuilder
 Audience is an effective targeting option that lets you
 intersect different segment attributes, such as detailed demographics and
 affinities, to create audiences that represent sections of your target
 segments.
Protobuf type google.ads.googleads.v18.resources.Audience
See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    Audience.Builder
    Audience is an effective targeting option that lets you intersect different segment attributes, such as detailed demographics and affinities, to create audiences that represent sections of your target segments.

    Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

    com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

    Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

    com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
    ASSET_GROUP_FIELD_NUMBER
     
    static final int
    DESCRIPTION_FIELD_NUMBER
     
    static final int
    DIMENSIONS_FIELD_NUMBER
     
    static final int
    EXCLUSION_DIMENSION_FIELD_NUMBER
     
    static final int
    ID_FIELD_NUMBER
     
    static final int
    NAME_FIELD_NUMBER
     
    static final int
    RESOURCE_NAME_FIELD_NUMBER
     
    static final int
    SCOPE_FIELD_NUMBER
     
    static final int
    STATUS_FIELD_NUMBER
     

    Fields inherited from class com.google.protobuf.GeneratedMessageV3

    alwaysUseFieldBuilders, unknownFields

    Fields inherited from class com.google.protobuf.AbstractMessage

    memoizedSize

    Fields inherited from class com.google.protobuf.AbstractMessageLite

    memoizedHashCode

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    equals(Object obj)
     
    String
    getAssetGroup()
    Immutable.
    com.google.protobuf.ByteString
    getAssetGroupBytes()
    Immutable.
    static Audience
    getDefaultInstance()
     
    Audience
    getDefaultInstanceForType()
     
    String
    getDescription()
    Description of this audience.
    com.google.protobuf.ByteString
    getDescriptionBytes()
    Description of this audience.
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    AudienceDimension
    getDimensions(int index)
    Positive dimensions specifying the audience composition.
    int
    getDimensionsCount()
    Positive dimensions specifying the audience composition.
    List<AudienceDimension>
    getDimensionsList()
    Positive dimensions specifying the audience composition.
    AudienceDimensionOrBuilder
    getDimensionsOrBuilder(int index)
    Positive dimensions specifying the audience composition.
    List<? extends AudienceDimensionOrBuilder>
    getDimensionsOrBuilderList()
    Positive dimensions specifying the audience composition.
    AudienceExclusionDimension
    getExclusionDimension()
    Negative dimension specifying the audience composition.
    AudienceExclusionDimensionOrBuilder
    getExclusionDimensionOrBuilder()
    Negative dimension specifying the audience composition.
    long
    getId()
    Output only.
    String
    getName()
    Name of the audience.
    com.google.protobuf.ByteString
    getNameBytes()
    Name of the audience.
    com.google.protobuf.Parser<Audience>
    getParserForType()
     
    String
    getResourceName()
    Immutable.
    com.google.protobuf.ByteString
    getResourceNameBytes()
    Immutable.
    AudienceScopeEnum.AudienceScope
    getScope()
    Defines the scope this audience can be used in.
    int
    getScopeValue()
    Defines the scope this audience can be used in.
    int
    getSerializedSize()
     
    AudienceStatusEnum.AudienceStatus
    getStatus()
    Output only.
    int
    getStatusValue()
    Output only.
    boolean
    hasExclusionDimension()
    Negative dimension specifying the audience composition.
    int
    hashCode()
     
    boolean
    hasName()
    Name of the audience.
    protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    final boolean
    isInitialized()
     
    static Audience.Builder
    newBuilder()
     
    static Audience.Builder
    newBuilder(Audience prototype)
     
    Audience.Builder
    newBuilderForType()
     
    protected Audience.Builder
    newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
     
    protected Object
    newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
     
    static Audience
    parseDelimitedFrom(InputStream input)
     
    static Audience
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Audience
    parseFrom(byte[] data)
     
    static Audience
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Audience
    parseFrom(com.google.protobuf.ByteString data)
     
    static Audience
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Audience
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    static Audience
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Audience
    parseFrom(InputStream input)
     
    static Audience
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Audience
    parseFrom(ByteBuffer data)
     
    static Audience
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<Audience>
    parser()
     
    Audience.Builder
    toBuilder()
     
    void
    writeTo(com.google.protobuf.CodedOutputStream output)
     

    Methods inherited from class com.google.protobuf.GeneratedMessageV3

    canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

    Methods inherited from class com.google.protobuf.AbstractMessage

    findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

    Methods inherited from class com.google.protobuf.AbstractMessageLite

    addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

    Methods inherited from interface com.google.protobuf.MessageLite

    toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

    findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

  • Field Details

  • Method Details

    • newInstance

      protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
      Overrides:
      newInstance 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 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) = { ... }
      Specified by:
      getResourceName in interface AudienceOrBuilder
      Returns:
      The resourceName.

    • getResourceNameBytes

      public 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) = { ... }
      Specified by:
      getResourceNameBytes in interface AudienceOrBuilder
      Returns:
      The bytes for resourceName.

    • getId

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

    • getStatusValue

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

    • getStatus

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

    • hasName

      public 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;
      Specified by:
      hasName in interface AudienceOrBuilder
      Returns:
      Whether the name field is set.

    • getName

      public 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;
      Specified by:
      getName in interface AudienceOrBuilder
      Returns:
      The name.

    • getNameBytes

      public 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;
      Specified by:
      getNameBytes in interface AudienceOrBuilder
      Returns:
      The bytes for name.

    • getDescription

      public String getDescription()
       Description of this audience.
      string description = 5;
      Specified by:
      getDescription in interface AudienceOrBuilder
      Returns:
      The description.

    • getDescriptionBytes

      public com.google.protobuf.ByteString getDescriptionBytes()
       Description of this audience.
      string description = 5;
      Specified by:
      getDescriptionBytes in interface AudienceOrBuilder
      Returns:
      The bytes for description.

    • getDimensionsList

      public List<AudienceDimension> getDimensionsList()
       Positive dimensions specifying the audience composition.
      repeated .google.ads.googleads.v18.common.AudienceDimension dimensions = 6;
      Specified by:
      getDimensionsList in interface AudienceOrBuilder

    • getDimensionsOrBuilderList

      public List<? extends AudienceDimensionOrBuilder> getDimensionsOrBuilderList()
       Positive dimensions specifying the audience composition.
      repeated .google.ads.googleads.v18.common.AudienceDimension dimensions = 6;
      Specified by:
      getDimensionsOrBuilderList in interface AudienceOrBuilder

    • getDimensionsCount

      public int getDimensionsCount()
       Positive dimensions specifying the audience composition.
      repeated .google.ads.googleads.v18.common.AudienceDimension dimensions = 6;
      Specified by:
      getDimensionsCount in interface AudienceOrBuilder

    • getDimensions

      public AudienceDimension getDimensions(int index)
       Positive dimensions specifying the audience composition.
      repeated .google.ads.googleads.v18.common.AudienceDimension dimensions = 6;
      Specified by:
      getDimensions in interface AudienceOrBuilder

    • getDimensionsOrBuilder

      public AudienceDimensionOrBuilder getDimensionsOrBuilder(int index)
       Positive dimensions specifying the audience composition.
      repeated .google.ads.googleads.v18.common.AudienceDimension dimensions = 6;
      Specified by:
      getDimensionsOrBuilder in interface AudienceOrBuilder

    • hasExclusionDimension

      public boolean hasExclusionDimension()
       Negative dimension specifying the audience composition.
      .google.ads.googleads.v18.common.AudienceExclusionDimension exclusion_dimension = 7;
      Specified by:
      hasExclusionDimension in interface AudienceOrBuilder
      Returns:
      Whether the exclusionDimension field is set.

    • getExclusionDimension

      public AudienceExclusionDimension getExclusionDimension()
       Negative dimension specifying the audience composition.
      .google.ads.googleads.v18.common.AudienceExclusionDimension exclusion_dimension = 7;
      Specified by:
      getExclusionDimension in interface AudienceOrBuilder
      Returns:
      The exclusionDimension.

    • getExclusionDimensionOrBuilder

      public AudienceExclusionDimensionOrBuilder getExclusionDimensionOrBuilder()
       Negative dimension specifying the audience composition.
      .google.ads.googleads.v18.common.AudienceExclusionDimension exclusion_dimension = 7;
      Specified by:
      getExclusionDimensionOrBuilder in interface AudienceOrBuilder

    • getScopeValue

      public 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.v18.enums.AudienceScopeEnum.AudienceScope scope = 8;
      Specified by:
      getScopeValue in interface AudienceOrBuilder
      Returns:
      The enum numeric value on the wire for scope.

    • getScope

      public 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.v18.enums.AudienceScopeEnum.AudienceScope scope = 8;
      Specified by:
      getScope in interface AudienceOrBuilder
      Returns:
      The scope.

    • getAssetGroup

      public 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) = { ... }
      Specified by:
      getAssetGroup in interface AudienceOrBuilder
      Returns:
      The assetGroup.

    • getAssetGroupBytes

      public 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) = { ... }
      Specified by:
      getAssetGroupBytes in interface AudienceOrBuilder
      Returns:
      The bytes for assetGroup.

    • 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 IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessageV3
      Throws:
      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(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 Audience parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Audience parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

      public static Audience parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static Audience parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static Audience parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static Audience parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static Audience parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static Audience parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

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

    • newBuilder

      public static Audience.Builder newBuilder()

    • newBuilder

      public static Audience.Builder newBuilder(Audience prototype)

    • toBuilder

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

    • newBuilderForType

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

    • getDefaultInstance

      public static Audience getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<Audience> parser()

    • getParserForType

      public com.google.protobuf.Parser<Audience> 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 Audience getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder