Class ChangeEvent

  • All Implemented Interfaces:
    ChangeEventOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, java.io.Serializable

    public final class ChangeEvent
    extends com.google.protobuf.GeneratedMessageV3
    implements ChangeEventOrBuilder
     Describes the granular change of returned resource of certain resource types.
     Changes made through UI, API and new versions of Editor
     by external users (including external users, and internal users that can be
     shown externally) in the past 30 days will be shown. The change shows the old
     values of the changed fields before the change and the new values right after
     the change. ChangeEvent could have up to 3 minutes delay to reflect a new
     change.
     
    Protobuf type google.ads.googleads.v10.resources.ChangeEvent
    See Also:
    Serialized Form
    • Field Detail

      • RESOURCE_NAME_FIELD_NUMBER

        public static final int RESOURCE_NAME_FIELD_NUMBER
        See Also:
        Constant Field Values
      • CHANGE_DATE_TIME_FIELD_NUMBER

        public static final int CHANGE_DATE_TIME_FIELD_NUMBER
        See Also:
        Constant Field Values
      • CHANGE_RESOURCE_TYPE_FIELD_NUMBER

        public static final int CHANGE_RESOURCE_TYPE_FIELD_NUMBER
        See Also:
        Constant Field Values
      • CHANGE_RESOURCE_NAME_FIELD_NUMBER

        public static final int CHANGE_RESOURCE_NAME_FIELD_NUMBER
        See Also:
        Constant Field Values
      • CLIENT_TYPE_FIELD_NUMBER

        public static final int CLIENT_TYPE_FIELD_NUMBER
        See Also:
        Constant Field Values
      • USER_EMAIL_FIELD_NUMBER

        public static final int USER_EMAIL_FIELD_NUMBER
        See Also:
        Constant Field Values
      • OLD_RESOURCE_FIELD_NUMBER

        public static final int OLD_RESOURCE_FIELD_NUMBER
        See Also:
        Constant Field Values
      • NEW_RESOURCE_FIELD_NUMBER

        public static final int NEW_RESOURCE_FIELD_NUMBER
        See Also:
        Constant Field Values
      • RESOURCE_CHANGE_OPERATION_FIELD_NUMBER

        public static final int RESOURCE_CHANGE_OPERATION_FIELD_NUMBER
        See Also:
        Constant Field Values
      • CHANGED_FIELDS_FIELD_NUMBER

        public static final int CHANGED_FIELDS_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
      • 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()
         Output only. The resource name of the change event.
         Change event resource names have the form:
         `customers/{customer_id}/changeEvents/{timestamp_micros}~{command_index}~{mutate_index}`
         
        string resource_name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
        Specified by:
        getResourceName in interface ChangeEventOrBuilder
        Returns:
        The resourceName.
      • getResourceNameBytes

        public com.google.protobuf.ByteString getResourceNameBytes()
         Output only. The resource name of the change event.
         Change event resource names have the form:
         `customers/{customer_id}/changeEvents/{timestamp_micros}~{command_index}~{mutate_index}`
         
        string resource_name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
        Specified by:
        getResourceNameBytes in interface ChangeEventOrBuilder
        Returns:
        The bytes for resourceName.
      • getChangeDateTime

        public java.lang.String getChangeDateTime()
         Output only. Time at which the change was committed on this resource.
         
        string change_date_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getChangeDateTime in interface ChangeEventOrBuilder
        Returns:
        The changeDateTime.
      • getChangeDateTimeBytes

        public com.google.protobuf.ByteString getChangeDateTimeBytes()
         Output only. Time at which the change was committed on this resource.
         
        string change_date_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getChangeDateTimeBytes in interface ChangeEventOrBuilder
        Returns:
        The bytes for changeDateTime.
      • getChangeResourceTypeValue

        public int getChangeResourceTypeValue()
         Output only. The type of the changed resource. This dictates what resource
         will be set in old_resource and new_resource.
         
        .google.ads.googleads.v10.enums.ChangeEventResourceTypeEnum.ChangeEventResourceType change_resource_type = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getChangeResourceTypeValue in interface ChangeEventOrBuilder
        Returns:
        The enum numeric value on the wire for changeResourceType.
      • getChangeResourceType

        public ChangeEventResourceTypeEnum.ChangeEventResourceType getChangeResourceType()
         Output only. The type of the changed resource. This dictates what resource
         will be set in old_resource and new_resource.
         
        .google.ads.googleads.v10.enums.ChangeEventResourceTypeEnum.ChangeEventResourceType change_resource_type = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getChangeResourceType in interface ChangeEventOrBuilder
        Returns:
        The changeResourceType.
      • getChangeResourceName

        public java.lang.String getChangeResourceName()
         Output only. The Simply resource this change occurred on.
         
        string change_resource_name = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getChangeResourceName in interface ChangeEventOrBuilder
        Returns:
        The changeResourceName.
      • getChangeResourceNameBytes

        public com.google.protobuf.ByteString getChangeResourceNameBytes()
         Output only. The Simply resource this change occurred on.
         
        string change_resource_name = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getChangeResourceNameBytes in interface ChangeEventOrBuilder
        Returns:
        The bytes for changeResourceName.
      • getClientTypeValue

        public int getClientTypeValue()
         Output only. Where the change was made through.
         
        .google.ads.googleads.v10.enums.ChangeClientTypeEnum.ChangeClientType client_type = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getClientTypeValue in interface ChangeEventOrBuilder
        Returns:
        The enum numeric value on the wire for clientType.
      • getUserEmail

        public java.lang.String getUserEmail()
         Output only. The email of the user who made this change.
         
        string user_email = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getUserEmail in interface ChangeEventOrBuilder
        Returns:
        The userEmail.
      • getUserEmailBytes

        public com.google.protobuf.ByteString getUserEmailBytes()
         Output only. The email of the user who made this change.
         
        string user_email = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getUserEmailBytes in interface ChangeEventOrBuilder
        Returns:
        The bytes for userEmail.
      • hasOldResource

        public boolean hasOldResource()
         Output only. The old resource before the change. Only changed fields will be populated.
         
        .google.ads.googleads.v10.resources.ChangeEvent.ChangedResource old_resource = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        hasOldResource in interface ChangeEventOrBuilder
        Returns:
        Whether the oldResource field is set.
      • getOldResource

        public ChangeEvent.ChangedResource getOldResource()
         Output only. The old resource before the change. Only changed fields will be populated.
         
        .google.ads.googleads.v10.resources.ChangeEvent.ChangedResource old_resource = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getOldResource in interface ChangeEventOrBuilder
        Returns:
        The oldResource.
      • hasNewResource

        public boolean hasNewResource()
         Output only. The new resource after the change. Only changed fields will be populated.
         
        .google.ads.googleads.v10.resources.ChangeEvent.ChangedResource new_resource = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        hasNewResource in interface ChangeEventOrBuilder
        Returns:
        Whether the newResource field is set.
      • getNewResource

        public ChangeEvent.ChangedResource getNewResource()
         Output only. The new resource after the change. Only changed fields will be populated.
         
        .google.ads.googleads.v10.resources.ChangeEvent.ChangedResource new_resource = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getNewResource in interface ChangeEventOrBuilder
        Returns:
        The newResource.
      • getResourceChangeOperationValue

        public int getResourceChangeOperationValue()
         Output only. The operation on the changed resource.
         
        .google.ads.googleads.v10.enums.ResourceChangeOperationEnum.ResourceChangeOperation resource_change_operation = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getResourceChangeOperationValue in interface ChangeEventOrBuilder
        Returns:
        The enum numeric value on the wire for resourceChangeOperation.
      • hasChangedFields

        public boolean hasChangedFields()
         Output only. A list of fields that are changed in the returned resource.
         
        .google.protobuf.FieldMask changed_fields = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        hasChangedFields in interface ChangeEventOrBuilder
        Returns:
        Whether the changedFields field is set.
      • getChangedFields

        public com.google.protobuf.FieldMask getChangedFields()
         Output only. A list of fields that are changed in the returned resource.
         
        .google.protobuf.FieldMask changed_fields = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getChangedFields in interface ChangeEventOrBuilder
        Returns:
        The changedFields.
      • getChangedFieldsOrBuilder

        public com.google.protobuf.FieldMaskOrBuilder getChangedFieldsOrBuilder()
         Output only. A list of fields that are changed in the returned resource.
         
        .google.protobuf.FieldMask changed_fields = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getChangedFieldsOrBuilder in interface ChangeEventOrBuilder
      • getCampaign

        public java.lang.String getCampaign()
         Output only. The Campaign affected by this change.
         
        string campaign = 11 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
        Specified by:
        getCampaign in interface ChangeEventOrBuilder
        Returns:
        The campaign.
      • getCampaignBytes

        public com.google.protobuf.ByteString getCampaignBytes()
         Output only. The Campaign affected by this change.
         
        string campaign = 11 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
        Specified by:
        getCampaignBytes in interface ChangeEventOrBuilder
        Returns:
        The bytes for campaign.
      • getAdGroup

        public java.lang.String getAdGroup()
         Output only. The AdGroup affected by this change.
         
        string ad_group = 12 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
        Specified by:
        getAdGroup in interface ChangeEventOrBuilder
        Returns:
        The adGroup.
      • getAdGroupBytes

        public com.google.protobuf.ByteString getAdGroupBytes()
         Output only. The AdGroup affected by this change.
         
        string ad_group = 12 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
        Specified by:
        getAdGroupBytes in interface ChangeEventOrBuilder
        Returns:
        The bytes for adGroup.
      • getFeed

        public java.lang.String getFeed()
         Output only. The Feed affected by this change.
         
        string feed = 13 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
        Specified by:
        getFeed in interface ChangeEventOrBuilder
        Returns:
        The feed.
      • getFeedBytes

        public com.google.protobuf.ByteString getFeedBytes()
         Output only. The Feed affected by this change.
         
        string feed = 13 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
        Specified by:
        getFeedBytes in interface ChangeEventOrBuilder
        Returns:
        The bytes for feed.
      • getFeedItem

        public java.lang.String getFeedItem()
         Output only. The FeedItem affected by this change.
         
        string feed_item = 14 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
        Specified by:
        getFeedItem in interface ChangeEventOrBuilder
        Returns:
        The feedItem.
      • getFeedItemBytes

        public com.google.protobuf.ByteString getFeedItemBytes()
         Output only. The FeedItem affected by this change.
         
        string feed_item = 14 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
        Specified by:
        getFeedItemBytes in interface ChangeEventOrBuilder
        Returns:
        The bytes for feedItem.
      • getAsset

        public java.lang.String getAsset()
         Output only. The Asset affected by this change.
         
        string asset = 20 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
        Specified by:
        getAsset in interface ChangeEventOrBuilder
        Returns:
        The asset.
      • getAssetBytes

        public com.google.protobuf.ByteString getAssetBytes()
         Output only. The Asset affected by this change.
         
        string asset = 20 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
        Specified by:
        getAssetBytes in interface ChangeEventOrBuilder
        Returns:
        The bytes for asset.
      • 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 ChangeEvent parseFrom​(java.nio.ByteBuffer data)
                                     throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

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

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

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

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

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

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

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

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

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

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

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

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

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

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

        public static ChangeEvent getDefaultInstance()
      • parser

        public static com.google.protobuf.Parser<ChangeEvent> parser()
      • getParserForType

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