Package com.google.ads.googleads.v13.resources

Class OfflineUserDataJob

  • All Implemented Interfaces:
    OfflineUserDataJobOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, java.io.Serializable
    public final class OfflineUserDataJob
extends com.google.protobuf.GeneratedMessageV3
implements OfflineUserDataJobOrBuilder
     A job containing offline user data of store visitors, or user list members
 that will be processed asynchronously. The uploaded data isn't readable and
 the processing results of the job can only be read using
 GoogleAdsService.Search/SearchStream.
    Protobuf type google.ads.googleads.v13.resources.OfflineUserDataJob
    See Also:
    Serialized Form

    • Field Detail

      • RESOURCE_NAME_FIELD_NUMBER

        public static final int RESOURCE_NAME_FIELD_NUMBER
        See Also:
        Constant Field Values

      • EXTERNAL_ID_FIELD_NUMBER

        public static final int EXTERNAL_ID_FIELD_NUMBER
        See Also:
        Constant Field Values

      • FAILURE_REASON_FIELD_NUMBER

        public static final int FAILURE_REASON_FIELD_NUMBER
        See Also:
        Constant Field Values

      • OPERATION_METADATA_FIELD_NUMBER

        public static final int OPERATION_METADATA_FIELD_NUMBER
        See Also:
        Constant Field Values

      • CUSTOMER_MATCH_USER_LIST_METADATA_FIELD_NUMBER

        public static final int CUSTOMER_MATCH_USER_LIST_METADATA_FIELD_NUMBER
        See Also:
        Constant Field Values

      • STORE_SALES_METADATA_FIELD_NUMBER

        public static final int STORE_SALES_METADATA_FIELD_NUMBER
        See Also:
        Constant Field Values

    • Method Detail

      • newInstance

        protected java.lang.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 java.lang.String getResourceName()
         Immutable. The resource name of the offline user data job.
 Offline user data job resource names have the form:

 `customers/{customer_id}/offlineUserDataJobs/{offline_user_data_job_id}`
        string resource_name = 1 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { ... }
        Specified by:
        getResourceName in interface OfflineUserDataJobOrBuilder
        Returns:
        The resourceName.

      • getResourceNameBytes

        public com.google.protobuf.ByteString getResourceNameBytes()
         Immutable. The resource name of the offline user data job.
 Offline user data job resource names have the form:

 `customers/{customer_id}/offlineUserDataJobs/{offline_user_data_job_id}`
        string resource_name = 1 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { ... }
        Specified by:
        getResourceNameBytes in interface OfflineUserDataJobOrBuilder
        Returns:
        The bytes for resourceName.

      • hasId

        public boolean hasId()
         Output only. ID of this offline user data job.
        optional int64 id = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        hasId in interface OfflineUserDataJobOrBuilder
        Returns:
        Whether the id field is set.

      • getId

        public long getId()
         Output only. ID of this offline user data job.
        optional int64 id = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getId in interface OfflineUserDataJobOrBuilder
        Returns:
        The id.

      • hasExternalId

        public boolean hasExternalId()
         Immutable. User specified job ID.
        optional int64 external_id = 10 [(.google.api.field_behavior) = IMMUTABLE];
        Specified by:
        hasExternalId in interface OfflineUserDataJobOrBuilder
        Returns:
        Whether the externalId field is set.

      • getExternalId

        public long getExternalId()
         Immutable. User specified job ID.
        optional int64 external_id = 10 [(.google.api.field_behavior) = IMMUTABLE];
        Specified by:
        getExternalId in interface OfflineUserDataJobOrBuilder
        Returns:
        The externalId.

      • getTypeValue

        public int getTypeValue()
         Immutable. Type of the job.
        .google.ads.googleads.v13.enums.OfflineUserDataJobTypeEnum.OfflineUserDataJobType type = 4 [(.google.api.field_behavior) = IMMUTABLE];
        Specified by:
        getTypeValue in interface OfflineUserDataJobOrBuilder
        Returns:
        The enum numeric value on the wire for type.

      • getStatusValue

        public int getStatusValue()
         Output only. Status of the job.
        .google.ads.googleads.v13.enums.OfflineUserDataJobStatusEnum.OfflineUserDataJobStatus status = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getStatusValue in interface OfflineUserDataJobOrBuilder
        Returns:
        The enum numeric value on the wire for status.

      • getFailureReasonValue

        public int getFailureReasonValue()
         Output only. Reason for the processing failure, if status is FAILED.
        .google.ads.googleads.v13.enums.OfflineUserDataJobFailureReasonEnum.OfflineUserDataJobFailureReason failure_reason = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getFailureReasonValue in interface OfflineUserDataJobOrBuilder
        Returns:
        The enum numeric value on the wire for failureReason.

      • hasOperationMetadata

        public boolean hasOperationMetadata()
         Output only. Metadata of offline user data job depicting match rate range.
        .google.ads.googleads.v13.resources.OfflineUserDataJobMetadata operation_metadata = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        hasOperationMetadata in interface OfflineUserDataJobOrBuilder
        Returns:
        Whether the operationMetadata field is set.

      • getOperationMetadata

        public OfflineUserDataJobMetadata getOperationMetadata()
         Output only. Metadata of offline user data job depicting match rate range.
        .google.ads.googleads.v13.resources.OfflineUserDataJobMetadata operation_metadata = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getOperationMetadata in interface OfflineUserDataJobOrBuilder
        Returns:
        The operationMetadata.

      • hasCustomerMatchUserListMetadata

        public boolean hasCustomerMatchUserListMetadata()
         Immutable. Metadata for data updates to a CRM-based user list.
        .google.ads.googleads.v13.common.CustomerMatchUserListMetadata customer_match_user_list_metadata = 7 [(.google.api.field_behavior) = IMMUTABLE];
        Specified by:
        hasCustomerMatchUserListMetadata in interface OfflineUserDataJobOrBuilder
        Returns:
        Whether the customerMatchUserListMetadata field is set.

      • getCustomerMatchUserListMetadata

        public CustomerMatchUserListMetadata getCustomerMatchUserListMetadata()
         Immutable. Metadata for data updates to a CRM-based user list.
        .google.ads.googleads.v13.common.CustomerMatchUserListMetadata customer_match_user_list_metadata = 7 [(.google.api.field_behavior) = IMMUTABLE];
        Specified by:
        getCustomerMatchUserListMetadata in interface OfflineUserDataJobOrBuilder
        Returns:
        The customerMatchUserListMetadata.

      • hasStoreSalesMetadata

        public boolean hasStoreSalesMetadata()
         Immutable. Metadata for store sales data update.
        .google.ads.googleads.v13.common.StoreSalesMetadata store_sales_metadata = 8 [(.google.api.field_behavior) = IMMUTABLE];
        Specified by:
        hasStoreSalesMetadata in interface OfflineUserDataJobOrBuilder
        Returns:
        Whether the storeSalesMetadata field is set.

      • getStoreSalesMetadata

        public StoreSalesMetadata getStoreSalesMetadata()
         Immutable. Metadata for store sales data update.
        .google.ads.googleads.v13.common.StoreSalesMetadata store_sales_metadata = 8 [(.google.api.field_behavior) = IMMUTABLE];
        Specified by:
        getStoreSalesMetadata in interface OfflineUserDataJobOrBuilder
        Returns:
        The storeSalesMetadata.

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseDelimitedFrom

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

      • parseDelimitedFrom

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

      • parseFrom

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

      • parseFrom

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

      • newBuilderForType

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

      • toBuilder

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

      • newBuilderForType

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

      • getParserForType

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