Interface CustomInterestOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
CustomInterest, CustomInterest.Builder

public interface CustomInterestOrBuilder extends com.google.protobuf.MessageOrBuilder
  • Method Details

    • getResourceName

      String getResourceName()
       Immutable. The resource name of the custom interest.
       Custom interest resource names have the form:
      
       `customers/{customer_id}/customInterests/{custom_interest_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 interest.
       Custom interest resource names have the form:
      
       `customers/{customer_id}/customInterests/{custom_interest_id}`
       
      string resource_name = 1 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { ... }
      Returns:
      The bytes for resourceName.
    • hasId

      boolean hasId()
       Output only. Id of the custom interest.
       
      optional int64 id = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      Whether the id field is set.
    • getId

      long getId()
       Output only. Id of the custom interest.
       
      optional int64 id = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The id.
    • getStatusValue

      int getStatusValue()
       Status of this custom interest. Indicates whether the custom interest is
       enabled or removed.
       
      .google.ads.googleads.v18.enums.CustomInterestStatusEnum.CustomInterestStatus status = 3;
      Returns:
      The enum numeric value on the wire for status.
    • getStatus

       Status of this custom interest. Indicates whether the custom interest is
       enabled or removed.
       
      .google.ads.googleads.v18.enums.CustomInterestStatusEnum.CustomInterestStatus status = 3;
      Returns:
      The status.
    • hasName

      boolean hasName()
       Name of the custom interest. It should be unique across the same custom
       affinity audience.
       This field is required for create operations.
       
      optional string name = 9;
      Returns:
      Whether the name field is set.
    • getName

      String getName()
       Name of the custom interest. It should be unique across the same custom
       affinity audience.
       This field is required for create operations.
       
      optional string name = 9;
      Returns:
      The name.
    • getNameBytes

      com.google.protobuf.ByteString getNameBytes()
       Name of the custom interest. It should be unique across the same custom
       affinity audience.
       This field is required for create operations.
       
      optional string name = 9;
      Returns:
      The bytes for name.
    • getTypeValue

      int getTypeValue()
       Type of the custom interest, CUSTOM_AFFINITY or CUSTOM_INTENT.
       By default the type is set to CUSTOM_AFFINITY.
       
      .google.ads.googleads.v18.enums.CustomInterestTypeEnum.CustomInterestType type = 5;
      Returns:
      The enum numeric value on the wire for type.
    • getType

       Type of the custom interest, CUSTOM_AFFINITY or CUSTOM_INTENT.
       By default the type is set to CUSTOM_AFFINITY.
       
      .google.ads.googleads.v18.enums.CustomInterestTypeEnum.CustomInterestType type = 5;
      Returns:
      The type.
    • hasDescription

      boolean hasDescription()
       Description of this custom interest audience.
       
      optional string description = 10;
      Returns:
      Whether the description field is set.
    • getDescription

      String getDescription()
       Description of this custom interest audience.
       
      optional string description = 10;
      Returns:
      The description.
    • getDescriptionBytes

      com.google.protobuf.ByteString getDescriptionBytes()
       Description of this custom interest audience.
       
      optional string description = 10;
      Returns:
      The bytes for description.
    • getMembersList

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

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

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

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

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