Package com.google.ads.googleads.v10.services

Class PlannableLocation

  • All Implemented Interfaces:
    PlannableLocationOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, java.io.Serializable
    public final class PlannableLocation
extends com.google.protobuf.GeneratedMessageV3
implements PlannableLocationOrBuilder
     A plannable location: a country, a DMA, a metro region, a tv region,
 a province.
    Protobuf type google.ads.googleads.v10.services.PlannableLocation
    See Also:
    Serialized Form

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  PlannableLocation.Builder
      A plannable location: a country, a DMA, a metro region, a tv region, a province.

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

        com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage,​BuilderType extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType,​BuilderType>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, 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

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      boolean equals​(java.lang.Object obj)  
      java.lang.String getCountryCode()
      The ISO-3166-1 alpha-2 country code that is associated with the location.
      com.google.protobuf.ByteString getCountryCodeBytes()
      The ISO-3166-1 alpha-2 country code that is associated with the location.
      static PlannableLocation getDefaultInstance()  
      PlannableLocation getDefaultInstanceForType()  
      static com.google.protobuf.Descriptors.Descriptor getDescriptor()  
      java.lang.String getId()
      The location identifier.
      com.google.protobuf.ByteString getIdBytes()
      The location identifier.
      java.lang.String getLocationType()
      The location's type.
      com.google.protobuf.ByteString getLocationTypeBytes()
      The location's type.
      java.lang.String getName()
      The unique location name in english.
      com.google.protobuf.ByteString getNameBytes()
      The unique location name in english.
      long getParentCountryId()
      The parent country, not present if location is a country.
      com.google.protobuf.Parser<PlannableLocation> getParserForType()  
      int getSerializedSize()  
      com.google.protobuf.UnknownFieldSet getUnknownFields()  
      boolean hasCountryCode()
      The ISO-3166-1 alpha-2 country code that is associated with the location.
      int hashCode()  
      boolean hasId()
      The location identifier.
      boolean hasLocationType()
      The location's type.
      boolean hasName()
      The unique location name in english.
      boolean hasParentCountryId()
      The parent country, not present if location is a country.
      protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()  
      boolean isInitialized()  
      static PlannableLocation.Builder newBuilder()  
      static PlannableLocation.Builder newBuilder​(PlannableLocation prototype)  
      PlannableLocation.Builder newBuilderForType()  
      protected PlannableLocation.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)  
      protected java.lang.Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)  
      static PlannableLocation parseDelimitedFrom​(java.io.InputStream input)  
      static PlannableLocation parseDelimitedFrom​(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static PlannableLocation parseFrom​(byte[] data)  
      static PlannableLocation parseFrom​(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static PlannableLocation parseFrom​(com.google.protobuf.ByteString data)  
      static PlannableLocation parseFrom​(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static PlannableLocation parseFrom​(com.google.protobuf.CodedInputStream input)  
      static PlannableLocation parseFrom​(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static PlannableLocation parseFrom​(java.io.InputStream input)  
      static PlannableLocation parseFrom​(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static PlannableLocation parseFrom​(java.nio.ByteBuffer data)  
      static PlannableLocation parseFrom​(java.nio.ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static com.google.protobuf.Parser<PlannableLocation> parser()  
      PlannableLocation.Builder toBuilder()  
      void writeTo​(com.google.protobuf.CodedOutputStream output)  

      • Methods inherited from class com.google.protobuf.GeneratedMessageV3

        canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, internalGetMapField, isStringEmpty, makeExtensionsImmutable, 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, hasField, hasOneof

    • Method Detail

      • newInstance

        protected java.lang.Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class com.google.protobuf.GeneratedMessageV3

      • getUnknownFields

        public final com.google.protobuf.UnknownFieldSet getUnknownFields()
        Specified by:
        getUnknownFields in interface com.google.protobuf.MessageOrBuilder
        Overrides:
        getUnknownFields 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

      • hasId

        public boolean hasId()
         The location identifier.
        optional string id = 4;
        Specified by:
        hasId in interface PlannableLocationOrBuilder
        Returns:
        Whether the id field is set.

      • getId

        public java.lang.String getId()
         The location identifier.
        optional string id = 4;
        Specified by:
        getId in interface PlannableLocationOrBuilder
        Returns:
        The id.

      • getIdBytes

        public com.google.protobuf.ByteString getIdBytes()
         The location identifier.
        optional string id = 4;
        Specified by:
        getIdBytes in interface PlannableLocationOrBuilder
        Returns:
        The bytes for id.

      • hasName

        public boolean hasName()
         The unique location name in english.
        optional string name = 5;
        Specified by:
        hasName in interface PlannableLocationOrBuilder
        Returns:
        Whether the name field is set.

      • getName

        public java.lang.String getName()
         The unique location name in english.
        optional string name = 5;
        Specified by:
        getName in interface PlannableLocationOrBuilder
        Returns:
        The name.

      • getNameBytes

        public com.google.protobuf.ByteString getNameBytes()
         The unique location name in english.
        optional string name = 5;
        Specified by:
        getNameBytes in interface PlannableLocationOrBuilder
        Returns:
        The bytes for name.

      • hasParentCountryId

        public boolean hasParentCountryId()
         The parent country, not present if location is a country.
 If present will always be a GeoTargetConstant ID. Additional information,
 such as country name is provided by
 [ReachPlanService.ListPlannableLocations][google.ads.googleads.v10.services.ReachPlanService.ListPlannableLocations] or
 [GoogleAdsService.Search/SearchStream][].
        optional int64 parent_country_id = 6;
        Specified by:
        hasParentCountryId in interface PlannableLocationOrBuilder
        Returns:
        Whether the parentCountryId field is set.

      • getParentCountryId

        public long getParentCountryId()
         The parent country, not present if location is a country.
 If present will always be a GeoTargetConstant ID. Additional information,
 such as country name is provided by
 [ReachPlanService.ListPlannableLocations][google.ads.googleads.v10.services.ReachPlanService.ListPlannableLocations] or
 [GoogleAdsService.Search/SearchStream][].
        optional int64 parent_country_id = 6;
        Specified by:
        getParentCountryId in interface PlannableLocationOrBuilder
        Returns:
        The parentCountryId.

      • hasCountryCode

        public boolean hasCountryCode()
         The ISO-3166-1 alpha-2 country code that is associated with the location.
        optional string country_code = 7;
        Specified by:
        hasCountryCode in interface PlannableLocationOrBuilder
        Returns:
        Whether the countryCode field is set.

      • getCountryCode

        public java.lang.String getCountryCode()
         The ISO-3166-1 alpha-2 country code that is associated with the location.
        optional string country_code = 7;
        Specified by:
        getCountryCode in interface PlannableLocationOrBuilder
        Returns:
        The countryCode.

      • getCountryCodeBytes

        public com.google.protobuf.ByteString getCountryCodeBytes()
         The ISO-3166-1 alpha-2 country code that is associated with the location.
        optional string country_code = 7;
        Specified by:
        getCountryCodeBytes in interface PlannableLocationOrBuilder
        Returns:
        The bytes for countryCode.

      • hasLocationType

        public boolean hasLocationType()
         The location's type. Location types correspond to target_type returned by
 searching location type in [GoogleAdsService.Search/SearchStream][].
        optional string location_type = 8;
        Specified by:
        hasLocationType in interface PlannableLocationOrBuilder
        Returns:
        Whether the locationType field is set.

      • getLocationType

        public java.lang.String getLocationType()
         The location's type. Location types correspond to target_type returned by
 searching location type in [GoogleAdsService.Search/SearchStream][].
        optional string location_type = 8;
        Specified by:
        getLocationType in interface PlannableLocationOrBuilder
        Returns:
        The locationType.

      • getLocationTypeBytes

        public com.google.protobuf.ByteString getLocationTypeBytes()
         The location's type. Location types correspond to target_type returned by
 searching location type in [GoogleAdsService.Search/SearchStream][].
        optional string location_type = 8;
        Specified by:
        getLocationTypeBytes in interface PlannableLocationOrBuilder
        Returns:
        The bytes for locationType.

      • 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 java.io.IOException
        Specified by:
        writeTo in interface com.google.protobuf.MessageLite
        Overrides:
        writeTo in class com.google.protobuf.GeneratedMessageV3
        Throws:
        java.io.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​(java.lang.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 PlannableLocation parseFrom​(java.nio.ByteBuffer data)
                                   throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static PlannableLocation parseFrom​(java.nio.ByteBuffer data,
                                          com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                   throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

        public static PlannableLocation parseFrom​(java.io.InputStream input)
                                   throws java.io.IOException
        Throws:
        java.io.IOException

      • parseFrom

        public static PlannableLocation parseFrom​(java.io.InputStream input,
                                          com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                   throws java.io.IOException
        Throws:
        java.io.IOException

      • parseDelimitedFrom

        public static PlannableLocation parseDelimitedFrom​(java.io.InputStream input)
                                            throws java.io.IOException
        Throws:
        java.io.IOException

      • parseDelimitedFrom

        public static PlannableLocation parseDelimitedFrom​(java.io.InputStream input,
                                                   com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                            throws java.io.IOException
        Throws:
        java.io.IOException

      • parseFrom

        public static PlannableLocation parseFrom​(com.google.protobuf.CodedInputStream input)
                                   throws java.io.IOException
        Throws:
        java.io.IOException

      • parseFrom

        public static PlannableLocation parseFrom​(com.google.protobuf.CodedInputStream input,
                                          com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                   throws java.io.IOException
        Throws:
        java.io.IOException

      • newBuilderForType

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

      • toBuilder

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

      • newBuilderForType

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

      • getParserForType

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