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

Class SearchTermView

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
com.google.ads.googleads.v18.resources.SearchTermView
All Implemented Interfaces:
SearchTermViewOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
public final class SearchTermView extends com.google.protobuf.GeneratedMessageV3 implements SearchTermViewOrBuilder
 A search term view with metrics aggregated by search term at the ad group
 level.
Protobuf type google.ads.googleads.v18.resources.SearchTermView
See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    SearchTermView.Builder
    A search term view with metrics aggregated by search term at the ad group level.

    Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

    com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

    Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

    com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
    AD_GROUP_FIELD_NUMBER
     
    static final int
    RESOURCE_NAME_FIELD_NUMBER
     
    static final int
    SEARCH_TERM_FIELD_NUMBER
     
    static final int
    STATUS_FIELD_NUMBER
     

    Fields inherited from class com.google.protobuf.GeneratedMessageV3

    alwaysUseFieldBuilders, unknownFields

    Fields inherited from class com.google.protobuf.AbstractMessage

    memoizedSize

    Fields inherited from class com.google.protobuf.AbstractMessageLite

    memoizedHashCode

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    equals(Object obj)
     
    String
    getAdGroup()
    Output only.
    com.google.protobuf.ByteString
    getAdGroupBytes()
    Output only.
    static SearchTermView
    getDefaultInstance()
     
    SearchTermView
    getDefaultInstanceForType()
     
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    com.google.protobuf.Parser<SearchTermView>
    getParserForType()
     
    String
    getResourceName()
    Output only.
    com.google.protobuf.ByteString
    getResourceNameBytes()
    Output only.
    String
    getSearchTerm()
    Output only.
    com.google.protobuf.ByteString
    getSearchTermBytes()
    Output only.
    int
    getSerializedSize()
     
    SearchTermTargetingStatusEnum.SearchTermTargetingStatus
    getStatus()
    Output only.
    int
    getStatusValue()
    Output only.
    boolean
    hasAdGroup()
    Output only.
    int
    hashCode()
     
    boolean
    hasSearchTerm()
    Output only.
    protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    final boolean
    isInitialized()
     
    static SearchTermView.Builder
    newBuilder()
     
    static SearchTermView.Builder
    newBuilder(SearchTermView prototype)
     
    SearchTermView.Builder
    newBuilderForType()
     
    protected SearchTermView.Builder
    newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
     
    protected Object
    newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
     
    static SearchTermView
    parseDelimitedFrom(InputStream input)
     
    static SearchTermView
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static SearchTermView
    parseFrom(byte[] data)
     
    static SearchTermView
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static SearchTermView
    parseFrom(com.google.protobuf.ByteString data)
     
    static SearchTermView
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static SearchTermView
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    static SearchTermView
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static SearchTermView
    parseFrom(InputStream input)
     
    static SearchTermView
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static SearchTermView
    parseFrom(ByteBuffer data)
     
    static SearchTermView
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<SearchTermView>
    parser()
     
    SearchTermView.Builder
    toBuilder()
     
    void
    writeTo(com.google.protobuf.CodedOutputStream output)
     

    Methods inherited from class com.google.protobuf.GeneratedMessageV3

    canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

    Methods inherited from class com.google.protobuf.AbstractMessage

    findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

    Methods inherited from class com.google.protobuf.AbstractMessageLite

    addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

    Methods inherited from interface com.google.protobuf.MessageLite

    toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

    findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

  • Field Details

    • RESOURCE_NAME_FIELD_NUMBER

      public static final int RESOURCE_NAME_FIELD_NUMBER
      See Also:

    • SEARCH_TERM_FIELD_NUMBER

      public static final int SEARCH_TERM_FIELD_NUMBER
      See Also:

    • AD_GROUP_FIELD_NUMBER

      public static final int AD_GROUP_FIELD_NUMBER
      See Also:

    • STATUS_FIELD_NUMBER

      public static final int STATUS_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()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

    • getResourceName

      public String getResourceName()
       Output only. The resource name of the search term view.
 Search term view resource names have the form:

 `customers/{customer_id}/searchTermViews/{campaign_id}~{ad_group_id}~{URL-base64_search_term}`
      string resource_name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
      Specified by:
      getResourceName in interface SearchTermViewOrBuilder
      Returns:
      The resourceName.

    • getResourceNameBytes

      public com.google.protobuf.ByteString getResourceNameBytes()
       Output only. The resource name of the search term view.
 Search term view resource names have the form:

 `customers/{customer_id}/searchTermViews/{campaign_id}~{ad_group_id}~{URL-base64_search_term}`
      string resource_name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
      Specified by:
      getResourceNameBytes in interface SearchTermViewOrBuilder
      Returns:
      The bytes for resourceName.

    • hasSearchTerm

      public boolean hasSearchTerm()
       Output only. The search term.
      optional string search_term = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      hasSearchTerm in interface SearchTermViewOrBuilder
      Returns:
      Whether the searchTerm field is set.

    • getSearchTerm

      public String getSearchTerm()
       Output only. The search term.
      optional string search_term = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getSearchTerm in interface SearchTermViewOrBuilder
      Returns:
      The searchTerm.

    • getSearchTermBytes

      public com.google.protobuf.ByteString getSearchTermBytes()
       Output only. The search term.
      optional string search_term = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getSearchTermBytes in interface SearchTermViewOrBuilder
      Returns:
      The bytes for searchTerm.

    • hasAdGroup

      public boolean hasAdGroup()
       Output only. The ad group the search term served in.
      optional string ad_group = 6 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
      Specified by:
      hasAdGroup in interface SearchTermViewOrBuilder
      Returns:
      Whether the adGroup field is set.

    • getAdGroup

      public String getAdGroup()
       Output only. The ad group the search term served in.
      optional string ad_group = 6 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
      Specified by:
      getAdGroup in interface SearchTermViewOrBuilder
      Returns:
      The adGroup.

    • getAdGroupBytes

      public com.google.protobuf.ByteString getAdGroupBytes()
       Output only. The ad group the search term served in.
      optional string ad_group = 6 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
      Specified by:
      getAdGroupBytes in interface SearchTermViewOrBuilder
      Returns:
      The bytes for adGroup.

    • getStatusValue

      public int getStatusValue()
       Output only. Indicates whether the search term is currently one of your
 targeted or excluded keywords.
      .google.ads.googleads.v18.enums.SearchTermTargetingStatusEnum.SearchTermTargetingStatus status = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getStatusValue in interface SearchTermViewOrBuilder
      Returns:
      The enum numeric value on the wire for status.

    • getStatus

      public SearchTermTargetingStatusEnum.SearchTermTargetingStatus getStatus()
       Output only. Indicates whether the search term is currently one of your
 targeted or excluded keywords.
      .google.ads.googleads.v18.enums.SearchTermTargetingStatusEnum.SearchTermTargetingStatus status = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getStatus in interface SearchTermViewOrBuilder
      Returns:
      The status.

    • isInitialized

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

    • getSerializedSize

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

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseDelimitedFrom

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

    • parseDelimitedFrom

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

    • parseFrom

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

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static SearchTermView.Builder newBuilder()

    • newBuilder

      public static SearchTermView.Builder newBuilder(SearchTermView prototype)

    • toBuilder

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

    • newBuilderForType

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

    • getDefaultInstance

      public static SearchTermView getDefaultInstance()

    • parser

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

    • getParserForType

      public com.google.protobuf.Parser<SearchTermView> 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.GeneratedMessageV3

    • getDefaultInstanceForType

      public SearchTermView getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder