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

Class MutateGoogleAdsRequest

  • All Implemented Interfaces:
    MutateGoogleAdsRequestOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, java.io.Serializable
    public final class MutateGoogleAdsRequest
extends com.google.protobuf.GeneratedMessageV3
implements MutateGoogleAdsRequestOrBuilder
     Request message for [GoogleAdsService.Mutate][google.ads.googleads.v10.services.GoogleAdsService.Mutate].
    Protobuf type google.ads.googleads.v10.services.MutateGoogleAdsRequest
    See Also:
    Serialized Form

    • Field Detail

      • CUSTOMER_ID_FIELD_NUMBER

        public static final int CUSTOMER_ID_FIELD_NUMBER
        See Also:
        Constant Field Values

      • MUTATE_OPERATIONS_FIELD_NUMBER

        public static final int MUTATE_OPERATIONS_FIELD_NUMBER
        See Also:
        Constant Field Values

      • PARTIAL_FAILURE_FIELD_NUMBER

        public static final int PARTIAL_FAILURE_FIELD_NUMBER
        See Also:
        Constant Field Values

      • VALIDATE_ONLY_FIELD_NUMBER

        public static final int VALIDATE_ONLY_FIELD_NUMBER
        See Also:
        Constant Field Values

      • RESPONSE_CONTENT_TYPE_FIELD_NUMBER

        public static final int RESPONSE_CONTENT_TYPE_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

      • getCustomerId

        public java.lang.String getCustomerId()
         Required. The ID of the customer whose resources are being modified.
        string customer_id = 1 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getCustomerId in interface MutateGoogleAdsRequestOrBuilder
        Returns:
        The customerId.

      • getCustomerIdBytes

        public com.google.protobuf.ByteString getCustomerIdBytes()
         Required. The ID of the customer whose resources are being modified.
        string customer_id = 1 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getCustomerIdBytes in interface MutateGoogleAdsRequestOrBuilder
        Returns:
        The bytes for customerId.

      • getMutateOperationsList

        public java.util.List<MutateOperation> getMutateOperationsList()
         Required. The list of operations to perform on individual resources.
        repeated .google.ads.googleads.v10.services.MutateOperation mutate_operations = 2 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getMutateOperationsList in interface MutateGoogleAdsRequestOrBuilder

      • getMutateOperationsCount

        public int getMutateOperationsCount()
         Required. The list of operations to perform on individual resources.
        repeated .google.ads.googleads.v10.services.MutateOperation mutate_operations = 2 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getMutateOperationsCount in interface MutateGoogleAdsRequestOrBuilder

      • getMutateOperations

        public MutateOperation getMutateOperations​(int index)
         Required. The list of operations to perform on individual resources.
        repeated .google.ads.googleads.v10.services.MutateOperation mutate_operations = 2 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getMutateOperations in interface MutateGoogleAdsRequestOrBuilder

      • getPartialFailure

        public boolean getPartialFailure()
         If true, successful operations will be carried out and invalid
 operations will return errors. If false, all operations will be carried
 out in one transaction if and only if they are all valid.
 Default is false.
        bool partial_failure = 3;
        Specified by:
        getPartialFailure in interface MutateGoogleAdsRequestOrBuilder
        Returns:
        The partialFailure.

      • getValidateOnly

        public boolean getValidateOnly()
         If true, the request is validated but not executed. Only errors are
 returned, not results.
        bool validate_only = 4;
        Specified by:
        getValidateOnly in interface MutateGoogleAdsRequestOrBuilder
        Returns:
        The validateOnly.

      • getResponseContentTypeValue

        public int getResponseContentTypeValue()
         The response content type setting. Determines whether the mutable resource
 or just the resource name should be returned post mutation. The mutable
 resource will only be returned if the resource has the appropriate response
 field. E.g. MutateCampaignResult.campaign.
        .google.ads.googleads.v10.enums.ResponseContentTypeEnum.ResponseContentType response_content_type = 5;
        Specified by:
        getResponseContentTypeValue in interface MutateGoogleAdsRequestOrBuilder
        Returns:
        The enum numeric value on the wire for responseContentType.

      • getResponseContentType

        public ResponseContentTypeEnum.ResponseContentType getResponseContentType()
         The response content type setting. Determines whether the mutable resource
 or just the resource name should be returned post mutation. The mutable
 resource will only be returned if the resource has the appropriate response
 field. E.g. MutateCampaignResult.campaign.
        .google.ads.googleads.v10.enums.ResponseContentTypeEnum.ResponseContentType response_content_type = 5;
        Specified by:
        getResponseContentType in interface MutateGoogleAdsRequestOrBuilder
        Returns:
        The responseContentType.

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseDelimitedFrom

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

      • parseDelimitedFrom

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

      • parseFrom

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

      • parseFrom

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

      • newBuilderForType

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

      • toBuilder

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

      • newBuilderForType

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

      • getParserForType

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