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

Interface KnowledgeGraphEntitySearchOptionsOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
KnowledgeGraphEntitySearchOptions, KnowledgeGraphEntitySearchOptions.Builder
@Generated public interface KnowledgeGraphEntitySearchOptionsOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Details

    • getGetAllCreatorAttributes

      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];
      Returns:
      The getAllCreatorAttributes.

    • hasSearchFilter

      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];
      Returns:
      Whether the searchFilter field is set.

    • getSearchFilter

      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];
      Returns:
      The searchFilter.

    • getSearchFilterOrBuilder

      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];