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

Class ConversionAdjustmentUploadServiceClient

  • All Implemented Interfaces:
    com.google.api.gax.core.BackgroundResource, java.lang.AutoCloseable
    @Generated("by gapic-generator-java")
public class ConversionAdjustmentUploadServiceClient
extends java.lang.Object
implements com.google.api.gax.core.BackgroundResource
    Service Description: Service to upload conversion adjustments.

    This class provides the ability to make remote calls to the backing service through method calls that map to API methods. Sample code to get started: 

    
 try (ConversionAdjustmentUploadServiceClient conversionAdjustmentUploadServiceClient =
     ConversionAdjustmentUploadServiceClient.create()) {
   String customerId = "customerId-1581184615";
   List<ConversionAdjustment> conversionAdjustments = new ArrayList<>();
   boolean partialFailure = true;
   UploadConversionAdjustmentsResponse response =
       conversionAdjustmentUploadServiceClient.uploadConversionAdjustments(
           customerId, conversionAdjustments, partialFailure);
 }

    Note: close() needs to be called on the ConversionAdjustmentUploadServiceClient object to clean up resources such as threads. In the example above, try-with-resources is used, which automatically calls close().

    The surface of this class includes several types of Java methods for each of the API's methods:

    1. A "flattened" method. With this type of method, the fields of the request type have been converted into function parameters. It may be the case that not all fields are available as parameters, and not every API method will have a flattened method entry point.
    2. A "request object" method. This type of method only takes one parameter, a request object, which must be constructed before the call. Not every API method will have a request object method.
    3. A "callable" method. This type of method takes no parameters and returns an immutable API callable object, which can be used to initiate calls to the service.

    See the individual methods for example code.

    Many parameters require resource names to be formatted in a particular way. To assist with these names, this class includes a format method for each type of name, and additionally a parse method to extract the individual identifiers contained within names that are returned.

    This class can be customized by passing in a custom instance of ConversionAdjustmentUploadServiceSettings to create(). For example:

    To customize credentials: 

    
 ConversionAdjustmentUploadServiceSettings conversionAdjustmentUploadServiceSettings =
     ConversionAdjustmentUploadServiceSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 ConversionAdjustmentUploadServiceClient conversionAdjustmentUploadServiceClient =
     ConversionAdjustmentUploadServiceClient.create(conversionAdjustmentUploadServiceSettings);

    To customize the endpoint: 

    
 ConversionAdjustmentUploadServiceSettings conversionAdjustmentUploadServiceSettings =
     ConversionAdjustmentUploadServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
 ConversionAdjustmentUploadServiceClient conversionAdjustmentUploadServiceClient =
     ConversionAdjustmentUploadServiceClient.create(conversionAdjustmentUploadServiceSettings);

    Please refer to the GitHub repository's samples for more quickstart code snippets.

    • Constructor Detail

      • ConversionAdjustmentUploadServiceClient

        protected ConversionAdjustmentUploadServiceClient​(ConversionAdjustmentUploadServiceSettings settings)
                                           throws java.io.IOException
        Constructs an instance of ConversionAdjustmentUploadServiceClient, using the given settings. This is protected so that it is easy to make a subclass, but otherwise, the static factory methods should be preferred.
        Throws:
        java.io.IOException

      • ConversionAdjustmentUploadServiceClient

        @BetaApi("A restructuring of stub classes is planned, so this may break in the future")
protected ConversionAdjustmentUploadServiceClient​(ConversionAdjustmentUploadServiceStub stub)

    • Method Detail

      • create

        public static final ConversionAdjustmentUploadServiceClient create()
                                                            throws java.io.IOException
        Constructs an instance of ConversionAdjustmentUploadServiceClient with default settings.
        Throws:
        java.io.IOException

      • create

        @BetaApi("A restructuring of stub classes is planned, so this may break in the future")
public static final ConversionAdjustmentUploadServiceClient create​(ConversionAdjustmentUploadServiceStub stub)
        Constructs an instance of ConversionAdjustmentUploadServiceClient, using the given stub for making calls. This is for advanced usage - prefer using create(ConversionAdjustmentUploadServiceSettings).

      • uploadConversionAdjustments

        public final UploadConversionAdjustmentsResponse uploadConversionAdjustments​(java.lang.String customerId,
                                                                             java.util.List<ConversionAdjustment> conversionAdjustments,
                                                                             boolean partialFailure)
        Processes the given conversion adjustments.

        List of thrown errors: [AuthenticationError]() [AuthorizationError]() [HeaderError]() [InternalError]() [PartialFailureError]() [QuotaError]() [RequestError]()

        Sample code: 

        
 try (ConversionAdjustmentUploadServiceClient conversionAdjustmentUploadServiceClient =
     ConversionAdjustmentUploadServiceClient.create()) {
   String customerId = "customerId-1581184615";
   List<ConversionAdjustment> conversionAdjustments = new ArrayList<>();
   boolean partialFailure = true;
   UploadConversionAdjustmentsResponse response =
       conversionAdjustmentUploadServiceClient.uploadConversionAdjustments(
           customerId, conversionAdjustments, partialFailure);
 }
        Parameters:
        customerId - Required. The ID of the customer performing the upload.
        conversionAdjustments - Required. The conversion adjustments that are being uploaded.
        partialFailure - Required. 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. This should always be set to true. See https://developers.google.com/google-ads/api/docs/best-practices/partial-failures for more information about partial failure.
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails

      • uploadConversionAdjustments

        public final UploadConversionAdjustmentsResponse uploadConversionAdjustments​(UploadConversionAdjustmentsRequest request)
        Processes the given conversion adjustments.

        List of thrown errors: [AuthenticationError]() [AuthorizationError]() [HeaderError]() [InternalError]() [PartialFailureError]() [QuotaError]() [RequestError]()

        Sample code: 

        
 try (ConversionAdjustmentUploadServiceClient conversionAdjustmentUploadServiceClient =
     ConversionAdjustmentUploadServiceClient.create()) {
   UploadConversionAdjustmentsRequest request =
       UploadConversionAdjustmentsRequest.newBuilder()
           .setCustomerId("customerId-1581184615")
           .addAllConversionAdjustments(new ArrayList<ConversionAdjustment>())
           .setPartialFailure(true)
           .setValidateOnly(true)
           .build();
   UploadConversionAdjustmentsResponse response =
       conversionAdjustmentUploadServiceClient.uploadConversionAdjustments(request);
 }
        Parameters:
        request - The request object containing all of the parameters for the API call.
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails

      • uploadConversionAdjustmentsCallable

        public final com.google.api.gax.rpc.UnaryCallable<UploadConversionAdjustmentsRequest,​UploadConversionAdjustmentsResponse> uploadConversionAdjustmentsCallable()
        Processes the given conversion adjustments.

        List of thrown errors: [AuthenticationError]() [AuthorizationError]() [HeaderError]() [InternalError]() [PartialFailureError]() [QuotaError]() [RequestError]()

        Sample code: 

        
 try (ConversionAdjustmentUploadServiceClient conversionAdjustmentUploadServiceClient =
     ConversionAdjustmentUploadServiceClient.create()) {
   UploadConversionAdjustmentsRequest request =
       UploadConversionAdjustmentsRequest.newBuilder()
           .setCustomerId("customerId-1581184615")
           .addAllConversionAdjustments(new ArrayList<ConversionAdjustment>())
           .setPartialFailure(true)
           .setValidateOnly(true)
           .build();
   ApiFuture<UploadConversionAdjustmentsResponse> future =
       conversionAdjustmentUploadServiceClient
           .uploadConversionAdjustmentsCallable()
           .futureCall(request);
   // Do something.
   UploadConversionAdjustmentsResponse response = future.get();
 }

      • close

        public final void close()
        Specified by:
        close in interface java.lang.AutoCloseable

      • shutdown

        public void shutdown()
        Specified by:
        shutdown in interface com.google.api.gax.core.BackgroundResource

      • isShutdown

        public boolean isShutdown()
        Specified by:
        isShutdown in interface com.google.api.gax.core.BackgroundResource

      • isTerminated

        public boolean isTerminated()
        Specified by:
        isTerminated in interface com.google.api.gax.core.BackgroundResource

      • shutdownNow

        public void shutdownNow()
        Specified by:
        shutdownNow in interface com.google.api.gax.core.BackgroundResource

      • awaitTermination

        public boolean awaitTermination​(long duration,
                                java.util.concurrent.TimeUnit unit)
                         throws java.lang.InterruptedException
        Specified by:
        awaitTermination in interface com.google.api.gax.core.BackgroundResource
        Throws:
        java.lang.InterruptedException