Package com.google.ads.googleads.v23.services

Class ApplyIncentiveRequest

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.protobuf.GeneratedMessage.ExtendableMessage<com.google.protobuf.GeneratedMessageV3>
com.google.protobuf.GeneratedMessageV3
com.google.ads.googleads.v23.services.ApplyIncentiveRequest
All Implemented Interfaces:
ApplyIncentiveRequestOrBuilder, com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<com.google.protobuf.GeneratedMessageV3>, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
public final class ApplyIncentiveRequest extends com.google.protobuf.GeneratedMessageV3 implements ApplyIncentiveRequestOrBuilder
 Request message for applying an incentive.
Protobuf type google.ads.googleads.v23.services.ApplyIncentiveRequest
See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    ApplyIncentiveRequest.Builder
    Request message for applying an incentive.

    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.GeneratedMessage.ExtendableMessage

    com.google.protobuf.GeneratedMessage.ExtendableMessage.ExtensionSerializer, com.google.protobuf.GeneratedMessage.ExtendableMessage.ExtensionWriter, com.google.protobuf.GeneratedMessage.ExtendableMessage.FieldEntry

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

    com.google.protobuf.GeneratedMessage.GeneratedExtension<ContainingT extends com.google.protobuf.Message,T extends Object>

    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
    COUNTRY_CODE_FIELD_NUMBER
     
    static final int
    CUSTOMER_ID_FIELD_NUMBER
     
    static final int
    SELECTED_INCENTIVE_ID_FIELD_NUMBER
     

    Fields inherited from class com.google.protobuf.GeneratedMessage

    alwaysUseFieldBuilders, loggedPre22TypeNames, 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
    getCountryCode()
    Required.
    com.google.protobuf.ByteString
    getCountryCodeBytes()
    Required.
    String
    getCustomerId()
    The customer ID of the account that the incentive is being applied to.
    com.google.protobuf.ByteString
    getCustomerIdBytes()
    The customer ID of the account that the incentive is being applied to.
    static ApplyIncentiveRequest
    getDefaultInstance()
     
    ApplyIncentiveRequest
    getDefaultInstanceForType()
     
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    com.google.protobuf.Parser<ApplyIncentiveRequest>
    getParserForType()
     
    long
    getSelectedIncentiveId()
    The incentive ID of this incentive.
    int
    getSerializedSize()
     
    boolean
    hasCountryCode()
    Required.
    boolean
    hasCustomerId()
    The customer ID of the account that the incentive is being applied to.
    int
    hashCode()
     
    boolean
    hasSelectedIncentiveId()
    The incentive ID of this incentive.
    protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    final boolean
    isInitialized()
     
    static ApplyIncentiveRequest.Builder
    newBuilder()
     
    static ApplyIncentiveRequest.Builder
    newBuilder(ApplyIncentiveRequest prototype)
     
    ApplyIncentiveRequest.Builder
    newBuilderForType()
     
    protected ApplyIncentiveRequest.Builder
    newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
     
    protected Object
    newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
     
    static ApplyIncentiveRequest
    parseDelimitedFrom(InputStream input)
     
    static ApplyIncentiveRequest
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static ApplyIncentiveRequest
    parseFrom(byte[] data)
     
    static ApplyIncentiveRequest
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static ApplyIncentiveRequest
    parseFrom(com.google.protobuf.ByteString data)
     
    static ApplyIncentiveRequest
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static ApplyIncentiveRequest
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    static ApplyIncentiveRequest
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static ApplyIncentiveRequest
    parseFrom(InputStream input)
     
    static ApplyIncentiveRequest
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static ApplyIncentiveRequest
    parseFrom(ByteBuffer data)
     
    static ApplyIncentiveRequest
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<ApplyIncentiveRequest>
    parser()
     
    ApplyIncentiveRequest.Builder
    toBuilder()
     
    void
    writeTo(com.google.protobuf.CodedOutputStream output)
     

    Methods inherited from class com.google.protobuf.GeneratedMessageV3

    mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList

    Methods inherited from class com.google.protobuf.GeneratedMessage.ExtendableMessage

    extensionsAreInitialized, extensionsIterator, extensionsSerializedSize, extensionsSerializedSizeAsMessageSet, getAllFields, getAllFieldsRaw, getExtension, getExtension, getExtensionCount, getExtensionFields, getField, getRepeatedField, getRepeatedFieldCount, hasExtension, hasField, makeExtensionsImmutable, newExtensionSerializer, newExtensionWriter, newMessageSetExtensionSerializer, newMessageSetExtensionWriter

    Methods inherited from class com.google.protobuf.GeneratedMessage

    canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getDescriptorForType, getOneofFieldDescriptor, getUnknownFields, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, newFileScopedGeneratedExtension, newInstance, newMessageScopedGeneratedExtension, 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, hashFields, toString

    Methods inherited from class com.google.protobuf.AbstractMessageLite

    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.GeneratedMessage.ExtendableMessageOrBuilder

    getExtension, getExtension, getExtension, getExtension, getExtensionCount, getExtensionCount, hasExtension, hasExtension

    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

    • SELECTED_INCENTIVE_ID_FIELD_NUMBER

      public static final int SELECTED_INCENTIVE_ID_FIELD_NUMBER
      See Also:

    • CUSTOMER_ID_FIELD_NUMBER

      public static final int CUSTOMER_ID_FIELD_NUMBER
      See Also:

    • COUNTRY_CODE_FIELD_NUMBER

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

    • hasSelectedIncentiveId

      public boolean hasSelectedIncentiveId()
       The incentive ID of this incentive. This is used to identify which
 incentive is selected by the user in the CYO flow.
      optional int64 selected_incentive_id = 1;
      Specified by:
      hasSelectedIncentiveId in interface ApplyIncentiveRequestOrBuilder
      Returns:
      Whether the selectedIncentiveId field is set.

    • getSelectedIncentiveId

      public long getSelectedIncentiveId()
       The incentive ID of this incentive. This is used to identify which
 incentive is selected by the user in the CYO flow.
      optional int64 selected_incentive_id = 1;
      Specified by:
      getSelectedIncentiveId in interface ApplyIncentiveRequestOrBuilder
      Returns:
      The selectedIncentiveId.

    • hasCustomerId

      public boolean hasCustomerId()
       The customer ID of the account that the incentive is being applied to.
      optional string customer_id = 2;
      Specified by:
      hasCustomerId in interface ApplyIncentiveRequestOrBuilder
      Returns:
      Whether the customerId field is set.

    • getCustomerId

      public String getCustomerId()
       The customer ID of the account that the incentive is being applied to.
      optional string customer_id = 2;
      Specified by:
      getCustomerId in interface ApplyIncentiveRequestOrBuilder
      Returns:
      The customerId.

    • getCustomerIdBytes

      public com.google.protobuf.ByteString getCustomerIdBytes()
       The customer ID of the account that the incentive is being applied to.
      optional string customer_id = 2;
      Specified by:
      getCustomerIdBytes in interface ApplyIncentiveRequestOrBuilder
      Returns:
      The bytes for customerId.

    • hasCountryCode

      public boolean hasCountryCode()
       Required. User's country code.
 Required. This field must be equal to the Google Ads account's billing
 country. Incentive eligibility, terms of service, and reward values are
 often country-specific. This country code is used to ensure the selected
 incentive is applicable to the user.
 Possible country codes:
 https://developers.google.com/google-ads/api/data/codes-formats#country_codes
      optional string country_code = 3 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      hasCountryCode in interface ApplyIncentiveRequestOrBuilder
      Returns:
      Whether the countryCode field is set.

    • getCountryCode

      public String getCountryCode()
       Required. User's country code.
 Required. This field must be equal to the Google Ads account's billing
 country. Incentive eligibility, terms of service, and reward values are
 often country-specific. This country code is used to ensure the selected
 incentive is applicable to the user.
 Possible country codes:
 https://developers.google.com/google-ads/api/data/codes-formats#country_codes
      optional string country_code = 3 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getCountryCode in interface ApplyIncentiveRequestOrBuilder
      Returns:
      The countryCode.

    • getCountryCodeBytes

      public com.google.protobuf.ByteString getCountryCodeBytes()
       Required. User's country code.
 Required. This field must be equal to the Google Ads account's billing
 country. Incentive eligibility, terms of service, and reward values are
 often country-specific. This country code is used to ensure the selected
 incentive is applicable to the user.
 Possible country codes:
 https://developers.google.com/google-ads/api/data/codes-formats#country_codes
      optional string country_code = 3 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getCountryCodeBytes in interface ApplyIncentiveRequestOrBuilder
      Returns:
      The bytes for countryCode.

    • isInitialized

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

    • getSerializedSize

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

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseDelimitedFrom

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

    • parseDelimitedFrom

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

    • parseFrom

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

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static ApplyIncentiveRequest.Builder newBuilder()

    • newBuilder

      public static ApplyIncentiveRequest.Builder newBuilder(ApplyIncentiveRequest prototype)

    • toBuilder

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

    • newBuilderForType

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

    • getDefaultInstance

      public static ApplyIncentiveRequest getDefaultInstance()

    • parser

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

    • getParserForType

      public com.google.protobuf.Parser<ApplyIncentiveRequest> 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.GeneratedMessage

    • getDefaultInstanceForType

      public ApplyIncentiveRequest getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<com.google.protobuf.GeneratedMessageV3>
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder