Package com.google.ads.googleads.v21.services

Class ListPlannableUserInterestsRequest

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.protobuf.GeneratedMessage.ExtendableMessage<com.google.protobuf.GeneratedMessageV3>
com.google.protobuf.GeneratedMessageV3
com.google.ads.googleads.v21.services.ListPlannableUserInterestsRequest
All Implemented Interfaces:
ListPlannableUserInterestsRequestOrBuilder, com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<com.google.protobuf.GeneratedMessageV3>, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
public final class ListPlannableUserInterestsRequest extends com.google.protobuf.GeneratedMessageV3 implements ListPlannableUserInterestsRequestOrBuilder
 Request message for
 [ReachPlanService.ListPlannableUserInterests][google.ads.googleads.v21.services.ReachPlanService.ListPlannableUserInterests].
Protobuf type google.ads.googleads.v21.services.ListPlannableUserInterestsRequest
See Also:

  • Field Details

    • CUSTOMER_ID_FIELD_NUMBER

      public static final int CUSTOMER_ID_FIELD_NUMBER
      See Also:

    • USER_INTEREST_TAXONOMY_TYPES_FIELD_NUMBER

      public static final int USER_INTEREST_TAXONOMY_TYPES_FIELD_NUMBER
      See Also:

    • NAME_QUERY_FIELD_NUMBER

      public static final int NAME_QUERY_FIELD_NUMBER
      See Also:

    • PATH_QUERY_FIELD_NUMBER

      public static final int PATH_QUERY_FIELD_NUMBER
      See Also:

    • REACH_APPLICATION_INFO_FIELD_NUMBER

      public static final int REACH_APPLICATION_INFO_FIELD_NUMBER
      See Also:

  • 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()
      Overrides:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

    • getCustomerId

      public String getCustomerId()
       Required. The ID of the customer.
      string customer_id = 1 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getCustomerId in interface ListPlannableUserInterestsRequestOrBuilder
      Returns:
      The customerId.

    • getCustomerIdBytes

      public com.google.protobuf.ByteString getCustomerIdBytes()
       Required. The ID of the customer.
      string customer_id = 1 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getCustomerIdBytes in interface ListPlannableUserInterestsRequestOrBuilder
      Returns:
      The bytes for customerId.

    • getUserInterestTaxonomyTypesList

      public List<UserInterestTaxonomyTypeEnum.UserInterestTaxonomyType> getUserInterestTaxonomyTypesList()
       Optional. A filter by user interest type. If set, only user interests with
 a type listed in the filter will be returned. If not set, user interests of
 all supported types will be returned. Supported user interest types are
 AFFINITY and IN_MARKET. Each type must be specified at most once.
      repeated .google.ads.googleads.v21.enums.UserInterestTaxonomyTypeEnum.UserInterestTaxonomyType user_interest_taxonomy_types = 2 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getUserInterestTaxonomyTypesList in interface ListPlannableUserInterestsRequestOrBuilder
      Returns:
      A list containing the userInterestTaxonomyTypes.

    • getUserInterestTaxonomyTypesCount

      public int getUserInterestTaxonomyTypesCount()
       Optional. A filter by user interest type. If set, only user interests with
 a type listed in the filter will be returned. If not set, user interests of
 all supported types will be returned. Supported user interest types are
 AFFINITY and IN_MARKET. Each type must be specified at most once.
      repeated .google.ads.googleads.v21.enums.UserInterestTaxonomyTypeEnum.UserInterestTaxonomyType user_interest_taxonomy_types = 2 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getUserInterestTaxonomyTypesCount in interface ListPlannableUserInterestsRequestOrBuilder
      Returns:
      The count of userInterestTaxonomyTypes.

    • getUserInterestTaxonomyTypes

      public UserInterestTaxonomyTypeEnum.UserInterestTaxonomyType getUserInterestTaxonomyTypes(int index)
       Optional. A filter by user interest type. If set, only user interests with
 a type listed in the filter will be returned. If not set, user interests of
 all supported types will be returned. Supported user interest types are
 AFFINITY and IN_MARKET. Each type must be specified at most once.
      repeated .google.ads.googleads.v21.enums.UserInterestTaxonomyTypeEnum.UserInterestTaxonomyType user_interest_taxonomy_types = 2 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getUserInterestTaxonomyTypes in interface ListPlannableUserInterestsRequestOrBuilder
      Parameters:
      index - The index of the element to return.
      Returns:
      The userInterestTaxonomyTypes at the given index.

    • getUserInterestTaxonomyTypesValueList

      public List<Integer> getUserInterestTaxonomyTypesValueList()
       Optional. A filter by user interest type. If set, only user interests with
 a type listed in the filter will be returned. If not set, user interests of
 all supported types will be returned. Supported user interest types are
 AFFINITY and IN_MARKET. Each type must be specified at most once.
      repeated .google.ads.googleads.v21.enums.UserInterestTaxonomyTypeEnum.UserInterestTaxonomyType user_interest_taxonomy_types = 2 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getUserInterestTaxonomyTypesValueList in interface ListPlannableUserInterestsRequestOrBuilder
      Returns:
      A list containing the enum numeric values on the wire for userInterestTaxonomyTypes.

    • getUserInterestTaxonomyTypesValue

      public int getUserInterestTaxonomyTypesValue(int index)
       Optional. A filter by user interest type. If set, only user interests with
 a type listed in the filter will be returned. If not set, user interests of
 all supported types will be returned. Supported user interest types are
 AFFINITY and IN_MARKET. Each type must be specified at most once.
      repeated .google.ads.googleads.v21.enums.UserInterestTaxonomyTypeEnum.UserInterestTaxonomyType user_interest_taxonomy_types = 2 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getUserInterestTaxonomyTypesValue in interface ListPlannableUserInterestsRequestOrBuilder
      Parameters:
      index - The index of the value to return.
      Returns:
      The enum numeric value on the wire of userInterestTaxonomyTypes at the given index.

    • hasNameQuery

      public boolean hasNameQuery()
       A filter by user interest name. If set, only user interests with a name
 containing the literal string (case insensitive) in the filter will be
 returned. Maximum length is 200 characters.
      optional string name_query = 3;
      Specified by:
      hasNameQuery in interface ListPlannableUserInterestsRequestOrBuilder
      Returns:
      Whether the nameQuery field is set.

    • getNameQuery

      public String getNameQuery()
       A filter by user interest name. If set, only user interests with a name
 containing the literal string (case insensitive) in the filter will be
 returned. Maximum length is 200 characters.
      optional string name_query = 3;
      Specified by:
      getNameQuery in interface ListPlannableUserInterestsRequestOrBuilder
      Returns:
      The nameQuery.

    • getNameQueryBytes

      public com.google.protobuf.ByteString getNameQueryBytes()
       A filter by user interest name. If set, only user interests with a name
 containing the literal string (case insensitive) in the filter will be
 returned. Maximum length is 200 characters.
      optional string name_query = 3;
      Specified by:
      getNameQueryBytes in interface ListPlannableUserInterestsRequestOrBuilder
      Returns:
      The bytes for nameQuery.

    • hasPathQuery

      public boolean hasPathQuery()
       A filter by user interest path. If set, only user interests with a path
 containing the literal string (case insensitive) in the filter will be
 returned. Maximum length is 200 characters.
      optional string path_query = 4;
      Specified by:
      hasPathQuery in interface ListPlannableUserInterestsRequestOrBuilder
      Returns:
      Whether the pathQuery field is set.

    • getPathQuery

      public String getPathQuery()
       A filter by user interest path. If set, only user interests with a path
 containing the literal string (case insensitive) in the filter will be
 returned. Maximum length is 200 characters.
      optional string path_query = 4;
      Specified by:
      getPathQuery in interface ListPlannableUserInterestsRequestOrBuilder
      Returns:
      The pathQuery.

    • getPathQueryBytes

      public com.google.protobuf.ByteString getPathQueryBytes()
       A filter by user interest path. If set, only user interests with a path
 containing the literal string (case insensitive) in the filter will be
 returned. Maximum length is 200 characters.
      optional string path_query = 4;
      Specified by:
      getPathQueryBytes in interface ListPlannableUserInterestsRequestOrBuilder
      Returns:
      The bytes for pathQuery.

    • hasReachApplicationInfo

      public boolean hasReachApplicationInfo()
       Optional. Additional information on the application issuing the request.
      .google.ads.googleads.v21.common.AdditionalApplicationInfo reach_application_info = 5 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      hasReachApplicationInfo in interface ListPlannableUserInterestsRequestOrBuilder
      Returns:
      Whether the reachApplicationInfo field is set.

    • getReachApplicationInfo

      public AdditionalApplicationInfo getReachApplicationInfo()
       Optional. Additional information on the application issuing the request.
      .google.ads.googleads.v21.common.AdditionalApplicationInfo reach_application_info = 5 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getReachApplicationInfo in interface ListPlannableUserInterestsRequestOrBuilder
      Returns:
      The reachApplicationInfo.

    • getReachApplicationInfoOrBuilder

      public AdditionalApplicationInfoOrBuilder getReachApplicationInfoOrBuilder()
       Optional. Additional information on the application issuing the request.
      .google.ads.googleads.v21.common.AdditionalApplicationInfo reach_application_info = 5 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getReachApplicationInfoOrBuilder in interface ListPlannableUserInterestsRequestOrBuilder

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage.ExtendableMessage<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.GeneratedMessage
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessage

    • 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 ListPlannableUserInterestsRequest parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseDelimitedFrom

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

    • parseDelimitedFrom

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

    • parseFrom

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

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static ListPlannableUserInterestsRequest.Builder newBuilder()

    • newBuilder

      public static ListPlannableUserInterestsRequest.Builder newBuilder(ListPlannableUserInterestsRequest prototype)

    • toBuilder

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

    • newBuilderForType

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

    • getDefaultInstance

      public static ListPlannableUserInterestsRequest getDefaultInstance()

    • parser

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

    • getParserForType

      public com.google.protobuf.Parser<ListPlannableUserInterestsRequest> 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.GeneratedMessage

    • getDefaultInstanceForType

      public ListPlannableUserInterestsRequest getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<com.google.protobuf.GeneratedMessageV3>
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder