Package com.google.ads.googleads.v10.resources

Class ConversionCustomVariable

  • All Implemented Interfaces:
    ConversionCustomVariableOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, java.io.Serializable
    public final class ConversionCustomVariable
extends com.google.protobuf.GeneratedMessageV3
implements ConversionCustomVariableOrBuilder
     A conversion custom variable
 See "About custom variables for conversions" at
 https://support.google.com/google-ads/answer/9964350
    Protobuf type google.ads.googleads.v10.resources.ConversionCustomVariable
    See Also:
    Serialized Form

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  ConversionCustomVariable.Builder
      A conversion custom variable See "About custom variables for conversions" at https://support.google.com/google-ads/answer/9964350

      • 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 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

      • getResourceName

        public java.lang.String getResourceName()
         Immutable. The resource name of the conversion custom variable.
 Conversion custom variable resource names have the form:
 `customers/{customer_id}/conversionCustomVariables/{conversion_custom_variable_id}`
        string resource_name = 1 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { ... }
        Specified by:
        getResourceName in interface ConversionCustomVariableOrBuilder
        Returns:
        The resourceName.

      • getResourceNameBytes

        public com.google.protobuf.ByteString getResourceNameBytes()
         Immutable. The resource name of the conversion custom variable.
 Conversion custom variable resource names have the form:
 `customers/{customer_id}/conversionCustomVariables/{conversion_custom_variable_id}`
        string resource_name = 1 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { ... }
        Specified by:
        getResourceNameBytes in interface ConversionCustomVariableOrBuilder
        Returns:
        The bytes for resourceName.

      • getId

        public long getId()
         Output only. The ID of the conversion custom variable.
        int64 id = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getId in interface ConversionCustomVariableOrBuilder
        Returns:
        The id.

      • getName

        public java.lang.String getName()
         Required. The name of the conversion custom variable.
 Name should be unique. The maximum length of name is 100 characters.
 There should not be any extra spaces before and after.
        string name = 3 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getName in interface ConversionCustomVariableOrBuilder
        Returns:
        The name.

      • getNameBytes

        public com.google.protobuf.ByteString getNameBytes()
         Required. The name of the conversion custom variable.
 Name should be unique. The maximum length of name is 100 characters.
 There should not be any extra spaces before and after.
        string name = 3 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getNameBytes in interface ConversionCustomVariableOrBuilder
        Returns:
        The bytes for name.

      • getTag

        public java.lang.String getTag()
         Required. Immutable. The tag of the conversion custom variable. It is used in the event snippet
 and sent to Google Ads along with conversion pings. For conversion uploads
 in Google Ads API, the resource name of the conversion custom variable is
 used.
 Tag should be unique. The maximum size of tag is 100 bytes.
 There should not be any extra spaces before and after.
 Currently only lowercase letters, numbers and underscores are allowed in
 the tag.
        string tag = 4 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];
        Specified by:
        getTag in interface ConversionCustomVariableOrBuilder
        Returns:
        The tag.

      • getTagBytes

        public com.google.protobuf.ByteString getTagBytes()
         Required. Immutable. The tag of the conversion custom variable. It is used in the event snippet
 and sent to Google Ads along with conversion pings. For conversion uploads
 in Google Ads API, the resource name of the conversion custom variable is
 used.
 Tag should be unique. The maximum size of tag is 100 bytes.
 There should not be any extra spaces before and after.
 Currently only lowercase letters, numbers and underscores are allowed in
 the tag.
        string tag = 4 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];
        Specified by:
        getTagBytes in interface ConversionCustomVariableOrBuilder
        Returns:
        The bytes for tag.

      • getStatusValue

        public int getStatusValue()
         The status of the conversion custom variable for conversion event accrual.
        .google.ads.googleads.v10.enums.ConversionCustomVariableStatusEnum.ConversionCustomVariableStatus status = 5;
        Specified by:
        getStatusValue in interface ConversionCustomVariableOrBuilder
        Returns:
        The enum numeric value on the wire for status.

      • getOwnerCustomer

        public java.lang.String getOwnerCustomer()
         Output only. The resource name of the customer that owns the conversion custom variable.
        string owner_customer = 6 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
        Specified by:
        getOwnerCustomer in interface ConversionCustomVariableOrBuilder
        Returns:
        The ownerCustomer.

      • getOwnerCustomerBytes

        public com.google.protobuf.ByteString getOwnerCustomerBytes()
         Output only. The resource name of the customer that owns the conversion custom variable.
        string owner_customer = 6 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
        Specified by:
        getOwnerCustomerBytes in interface ConversionCustomVariableOrBuilder
        Returns:
        The bytes for ownerCustomer.

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseDelimitedFrom

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

      • parseDelimitedFrom

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

      • parseFrom

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

      • parseFrom

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

      • newBuilderForType

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

      • toBuilder

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

      • newBuilderForType

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

      • getParserForType

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