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

Interface CustomAudienceOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
CustomAudience, CustomAudience.Builder
public interface CustomAudienceOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Details

    • getResourceName

      String getResourceName()
       Immutable. The resource name of the custom audience.
 Custom audience resource names have the form:

 `customers/{customer_id}/customAudiences/{custom_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 custom audience.
 Custom audience resource names have the form:

 `customers/{customer_id}/customAudiences/{custom_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 custom audience.
      int64 id = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The id.

    • getStatusValue

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

    • getStatus

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

    • getName

      String getName()
       Name of the custom audience. It should be unique for all custom audiences
 created by a customer.
 This field is required for creating operations.
      string name = 4;
      Returns:
      The name.

    • getNameBytes

      com.google.protobuf.ByteString getNameBytes()
       Name of the custom audience. It should be unique for all custom audiences
 created by a customer.
 This field is required for creating operations.
      string name = 4;
      Returns:
      The bytes for name.

    • getTypeValue

      int getTypeValue()
       Type of the custom audience.
 ("INTEREST" OR "PURCHASE_INTENT" is not allowed for newly created custom
 audience but kept for existing audiences)
      .google.ads.googleads.v18.enums.CustomAudienceTypeEnum.CustomAudienceType type = 5;
      Returns:
      The enum numeric value on the wire for type.

    • getType

      CustomAudienceTypeEnum.CustomAudienceType getType()
       Type of the custom audience.
 ("INTEREST" OR "PURCHASE_INTENT" is not allowed for newly created custom
 audience but kept for existing audiences)
      .google.ads.googleads.v18.enums.CustomAudienceTypeEnum.CustomAudienceType type = 5;
      Returns:
      The type.

    • getDescription

      String getDescription()
       Description of this custom audience.
      string description = 6;
      Returns:
      The description.

    • getDescriptionBytes

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

    • getMembersList

      List<CustomAudienceMember> getMembersList()
       List of custom audience members that this custom audience is composed of.
 Members can be added during CustomAudience creation. If members are
 presented in UPDATE operation, existing members will be overridden.
      repeated .google.ads.googleads.v18.resources.CustomAudienceMember members = 7;

    • getMembers

      CustomAudienceMember getMembers(int index)
       List of custom audience members that this custom audience is composed of.
 Members can be added during CustomAudience creation. If members are
 presented in UPDATE operation, existing members will be overridden.
      repeated .google.ads.googleads.v18.resources.CustomAudienceMember members = 7;

    • getMembersCount

      int getMembersCount()
       List of custom audience members that this custom audience is composed of.
 Members can be added during CustomAudience creation. If members are
 presented in UPDATE operation, existing members will be overridden.
      repeated .google.ads.googleads.v18.resources.CustomAudienceMember members = 7;

    • getMembersOrBuilderList

      List<? extends CustomAudienceMemberOrBuilder> getMembersOrBuilderList()
       List of custom audience members that this custom audience is composed of.
 Members can be added during CustomAudience creation. If members are
 presented in UPDATE operation, existing members will be overridden.
      repeated .google.ads.googleads.v18.resources.CustomAudienceMember members = 7;

    • getMembersOrBuilder

      CustomAudienceMemberOrBuilder getMembersOrBuilder(int index)
       List of custom audience members that this custom audience is composed of.
 Members can be added during CustomAudience creation. If members are
 presented in UPDATE operation, existing members will be overridden.
      repeated .google.ads.googleads.v18.resources.CustomAudienceMember members = 7;