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

Class ClickView

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
com.google.ads.googleads.v18.resources.ClickView
All Implemented Interfaces:
ClickViewOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
public final class ClickView extends com.google.protobuf.GeneratedMessageV3 implements ClickViewOrBuilder
 A click view with metrics aggregated at each click level, including both
 valid and invalid clicks. For non-Search campaigns, metrics.clicks
 represents the number of valid and invalid interactions.
 Queries including ClickView must have a filter limiting the results to one
 day and can be requested for dates back to 90 days before the time of the
 request.
Protobuf type google.ads.googleads.v18.resources.ClickView
See Also:

  • Field Details

    • RESOURCE_NAME_FIELD_NUMBER

      public static final int RESOURCE_NAME_FIELD_NUMBER
      See Also:

    • GCLID_FIELD_NUMBER

      public static final int GCLID_FIELD_NUMBER
      See Also:

    • AREA_OF_INTEREST_FIELD_NUMBER

      public static final int AREA_OF_INTEREST_FIELD_NUMBER
      See Also:

    • LOCATION_OF_PRESENCE_FIELD_NUMBER

      public static final int LOCATION_OF_PRESENCE_FIELD_NUMBER
      See Also:

    • PAGE_NUMBER_FIELD_NUMBER

      public static final int PAGE_NUMBER_FIELD_NUMBER
      See Also:

    • AD_GROUP_AD_FIELD_NUMBER

      public static final int AD_GROUP_AD_FIELD_NUMBER
      See Also:

    • CAMPAIGN_LOCATION_TARGET_FIELD_NUMBER

      public static final int CAMPAIGN_LOCATION_TARGET_FIELD_NUMBER
      See Also:

    • USER_LIST_FIELD_NUMBER

      public static final int USER_LIST_FIELD_NUMBER
      See Also:

    • KEYWORD_FIELD_NUMBER

      public static final int KEYWORD_FIELD_NUMBER
      See Also:

    • KEYWORD_INFO_FIELD_NUMBER

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

    • getResourceName

      public String getResourceName()
       Output only. The resource name of the click view.
 Click view resource names have the form:

 `customers/{customer_id}/clickViews/{date (yyyy-MM-dd)}~{gclid}`
      string resource_name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
      Specified by:
      getResourceName in interface ClickViewOrBuilder
      Returns:
      The resourceName.

    • getResourceNameBytes

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

 `customers/{customer_id}/clickViews/{date (yyyy-MM-dd)}~{gclid}`
      string resource_name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
      Specified by:
      getResourceNameBytes in interface ClickViewOrBuilder
      Returns:
      The bytes for resourceName.

    • hasGclid

      public boolean hasGclid()
       Output only. The Google Click ID.
      optional string gclid = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      hasGclid in interface ClickViewOrBuilder
      Returns:
      Whether the gclid field is set.

    • getGclid

      public String getGclid()
       Output only. The Google Click ID.
      optional string gclid = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getGclid in interface ClickViewOrBuilder
      Returns:
      The gclid.

    • getGclidBytes

      public com.google.protobuf.ByteString getGclidBytes()
       Output only. The Google Click ID.
      optional string gclid = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getGclidBytes in interface ClickViewOrBuilder
      Returns:
      The bytes for gclid.

    • hasAreaOfInterest

      public boolean hasAreaOfInterest()
       Output only. The location criteria matching the area of interest associated
 with the impression.
      .google.ads.googleads.v18.common.ClickLocation area_of_interest = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      hasAreaOfInterest in interface ClickViewOrBuilder
      Returns:
      Whether the areaOfInterest field is set.

    • getAreaOfInterest

      public ClickLocation getAreaOfInterest()
       Output only. The location criteria matching the area of interest associated
 with the impression.
      .google.ads.googleads.v18.common.ClickLocation area_of_interest = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getAreaOfInterest in interface ClickViewOrBuilder
      Returns:
      The areaOfInterest.

    • getAreaOfInterestOrBuilder

      public ClickLocationOrBuilder getAreaOfInterestOrBuilder()
       Output only. The location criteria matching the area of interest associated
 with the impression.
      .google.ads.googleads.v18.common.ClickLocation area_of_interest = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getAreaOfInterestOrBuilder in interface ClickViewOrBuilder

    • hasLocationOfPresence

      public boolean hasLocationOfPresence()
       Output only. The location criteria matching the location of presence
 associated with the impression.
      .google.ads.googleads.v18.common.ClickLocation location_of_presence = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      hasLocationOfPresence in interface ClickViewOrBuilder
      Returns:
      Whether the locationOfPresence field is set.

    • getLocationOfPresence

      public ClickLocation getLocationOfPresence()
       Output only. The location criteria matching the location of presence
 associated with the impression.
      .google.ads.googleads.v18.common.ClickLocation location_of_presence = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getLocationOfPresence in interface ClickViewOrBuilder
      Returns:
      The locationOfPresence.

    • getLocationOfPresenceOrBuilder

      public ClickLocationOrBuilder getLocationOfPresenceOrBuilder()
       Output only. The location criteria matching the location of presence
 associated with the impression.
      .google.ads.googleads.v18.common.ClickLocation location_of_presence = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getLocationOfPresenceOrBuilder in interface ClickViewOrBuilder

    • hasPageNumber

      public boolean hasPageNumber()
       Output only. Page number in search results where the ad was shown.
      optional int64 page_number = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      hasPageNumber in interface ClickViewOrBuilder
      Returns:
      Whether the pageNumber field is set.

    • getPageNumber

      public long getPageNumber()
       Output only. Page number in search results where the ad was shown.
      optional int64 page_number = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getPageNumber in interface ClickViewOrBuilder
      Returns:
      The pageNumber.

    • hasAdGroupAd

      public boolean hasAdGroupAd()
       Output only. The associated ad.
      optional string ad_group_ad = 10 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
      Specified by:
      hasAdGroupAd in interface ClickViewOrBuilder
      Returns:
      Whether the adGroupAd field is set.

    • getAdGroupAd

      public String getAdGroupAd()
       Output only. The associated ad.
      optional string ad_group_ad = 10 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
      Specified by:
      getAdGroupAd in interface ClickViewOrBuilder
      Returns:
      The adGroupAd.

    • getAdGroupAdBytes

      public com.google.protobuf.ByteString getAdGroupAdBytes()
       Output only. The associated ad.
      optional string ad_group_ad = 10 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
      Specified by:
      getAdGroupAdBytes in interface ClickViewOrBuilder
      Returns:
      The bytes for adGroupAd.

    • hasCampaignLocationTarget

      public boolean hasCampaignLocationTarget()
       Output only. The associated campaign location target, if one exists.
      optional string campaign_location_target = 11 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
      Specified by:
      hasCampaignLocationTarget in interface ClickViewOrBuilder
      Returns:
      Whether the campaignLocationTarget field is set.

    • getCampaignLocationTarget

      public String getCampaignLocationTarget()
       Output only. The associated campaign location target, if one exists.
      optional string campaign_location_target = 11 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
      Specified by:
      getCampaignLocationTarget in interface ClickViewOrBuilder
      Returns:
      The campaignLocationTarget.

    • getCampaignLocationTargetBytes

      public com.google.protobuf.ByteString getCampaignLocationTargetBytes()
       Output only. The associated campaign location target, if one exists.
      optional string campaign_location_target = 11 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
      Specified by:
      getCampaignLocationTargetBytes in interface ClickViewOrBuilder
      Returns:
      The bytes for campaignLocationTarget.

    • hasUserList

      public boolean hasUserList()
       Output only. The associated user list, if one exists.
      optional string user_list = 12 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
      Specified by:
      hasUserList in interface ClickViewOrBuilder
      Returns:
      Whether the userList field is set.

    • getUserList

      public String getUserList()
       Output only. The associated user list, if one exists.
      optional string user_list = 12 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
      Specified by:
      getUserList in interface ClickViewOrBuilder
      Returns:
      The userList.

    • getUserListBytes

      public com.google.protobuf.ByteString getUserListBytes()
       Output only. The associated user list, if one exists.
      optional string user_list = 12 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
      Specified by:
      getUserListBytes in interface ClickViewOrBuilder
      Returns:
      The bytes for userList.

    • getKeyword

      public String getKeyword()
       Output only. The associated keyword, if one exists and the click
 corresponds to the SEARCH channel.
      string keyword = 13 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
      Specified by:
      getKeyword in interface ClickViewOrBuilder
      Returns:
      The keyword.

    • getKeywordBytes

      public com.google.protobuf.ByteString getKeywordBytes()
       Output only. The associated keyword, if one exists and the click
 corresponds to the SEARCH channel.
      string keyword = 13 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
      Specified by:
      getKeywordBytes in interface ClickViewOrBuilder
      Returns:
      The bytes for keyword.

    • hasKeywordInfo

      public boolean hasKeywordInfo()
       Output only. Basic information about the associated keyword, if it exists.
      .google.ads.googleads.v18.common.KeywordInfo keyword_info = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      hasKeywordInfo in interface ClickViewOrBuilder
      Returns:
      Whether the keywordInfo field is set.

    • getKeywordInfo

      public KeywordInfo getKeywordInfo()
       Output only. Basic information about the associated keyword, if it exists.
      .google.ads.googleads.v18.common.KeywordInfo keyword_info = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getKeywordInfo in interface ClickViewOrBuilder
      Returns:
      The keywordInfo.

    • getKeywordInfoOrBuilder

      public KeywordInfoOrBuilder getKeywordInfoOrBuilder()
       Output only. Basic information about the associated keyword, if it exists.
      .google.ads.googleads.v18.common.KeywordInfo keyword_info = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getKeywordInfoOrBuilder in interface ClickViewOrBuilder

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseDelimitedFrom

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

    • parseDelimitedFrom

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

    • parseFrom

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

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static ClickView.Builder newBuilder()

    • newBuilder

      public static ClickView.Builder newBuilder(ClickView prototype)

    • toBuilder

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

    • newBuilderForType

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

    • getDefaultInstance

      public static ClickView getDefaultInstance()

    • parser

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

    • getParserForType

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