Package com.google.ads.googleads.v24.services

Class KnowledgeGraphEntitySearchOptions

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.ads.googleads.v24.services.KnowledgeGraphEntitySearchOptions
All Implemented Interfaces:
KnowledgeGraphEntitySearchOptionsOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
@Generated public final class KnowledgeGraphEntitySearchOptions extends com.google.protobuf.GeneratedMessage implements KnowledgeGraphEntitySearchOptionsOrBuilder
 Search options for Knowledge Graph Entities.
Protobuf type google.ads.googleads.v24.services.KnowledgeGraphEntitySearchOptions
See Also:

  • Field Details

    • GET_ALL_CREATOR_ATTRIBUTES_FIELD_NUMBER

      public static final int GET_ALL_CREATOR_ATTRIBUTES_FIELD_NUMBER
      See Also:

    • SEARCH_FILTER_FIELD_NUMBER

      public static final int SEARCH_FILTER_FIELD_NUMBER
      See Also:

  • Method Details

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage

    • getGetAllCreatorAttributes

      public boolean getGetAllCreatorAttributes()
       Optional. When true, retrieves all available Knowledge Graph Entities
 tagged with
 [CREATOR_ATTRIBUTE][google.ads.googleads.v24.enums.InsightsKnowledgeGraphEntityCapabilitiesEnum.InsightsKnowledgeGraphEntityCapabilities.CREATOR_ATTRIBUTE].
 KNOWLEDGE_GRAPH must be included in
 `ListAudienceInsightsAttributesRequest.dimensions` and the `query_text`
 must be empty.

 This option cannot be used with
 [search_filter][google.ads.googleads.v24.services.KnowledgeGraphEntitySearchOptions.search_filter].
 `search_filter` respects the `query_text` when retrieving relevant entities
 while this option returns all creator attributes available to use as an
 input.
      bool get_all_creator_attributes = 1 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getGetAllCreatorAttributes in interface KnowledgeGraphEntitySearchOptionsOrBuilder
      Returns:
      The getAllCreatorAttributes.

    • hasSearchFilter

      public boolean hasSearchFilter()
       Optional. Filter options for narrowing down the scope of Knowledge Graph
 Entities to retrieve.
      .google.ads.googleads.v24.services.KnowledgeGraphEntitySearchOptions.SearchFilter search_filter = 2 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      hasSearchFilter in interface KnowledgeGraphEntitySearchOptionsOrBuilder
      Returns:
      Whether the searchFilter field is set.

    • getSearchFilter

      public KnowledgeGraphEntitySearchOptions.SearchFilter getSearchFilter()
       Optional. Filter options for narrowing down the scope of Knowledge Graph
 Entities to retrieve.
      .google.ads.googleads.v24.services.KnowledgeGraphEntitySearchOptions.SearchFilter search_filter = 2 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getSearchFilter in interface KnowledgeGraphEntitySearchOptionsOrBuilder
      Returns:
      The searchFilter.

    • getSearchFilterOrBuilder

      public KnowledgeGraphEntitySearchOptions.SearchFilterOrBuilder getSearchFilterOrBuilder()
       Optional. Filter options for narrowing down the scope of Knowledge Graph
 Entities to retrieve.
      .google.ads.googleads.v24.services.KnowledgeGraphEntitySearchOptions.SearchFilter search_filter = 2 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getSearchFilterOrBuilder in interface KnowledgeGraphEntitySearchOptionsOrBuilder

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseDelimitedFrom

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

    • parseDelimitedFrom

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

    • parseFrom

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

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static KnowledgeGraphEntitySearchOptions.Builder newBuilder()

    • newBuilder

      public static KnowledgeGraphEntitySearchOptions.Builder newBuilder(KnowledgeGraphEntitySearchOptions prototype)

    • toBuilder

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

    • newBuilderForType

      protected KnowledgeGraphEntitySearchOptions.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage

    • getDefaultInstance

      public static KnowledgeGraphEntitySearchOptions getDefaultInstance()

    • parser

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

    • getParserForType

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