Package com.google.ads.googleads.v15.services

Class AdGroupBidModifierServiceClient

  • All Implemented Interfaces:
    com.google.api.gax.core.BackgroundResource, java.lang.AutoCloseable
    @Generated("by gapic-generator-java")
public class AdGroupBidModifierServiceClient
extends java.lang.Object
implements com.google.api.gax.core.BackgroundResource
    Service Description: Service to manage ad group bid modifiers.

    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: 

    
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AdGroupBidModifierServiceClient adGroupBidModifierServiceClient =
     AdGroupBidModifierServiceClient.create()) {
   String customerId = "customerId-1581184615";
   List<AdGroupBidModifierOperation> operations = new ArrayList<>();
   MutateAdGroupBidModifiersResponse response =
       adGroupBidModifierServiceClient.mutateAdGroupBidModifiers(customerId, operations);
 }

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

    Methods
    Method Description Method Variants

    MutateAdGroupBidModifiers

    Creates, updates, or removes ad group bid modifiers. Operation statuses are returned.

    List of thrown errors: [AdGroupBidModifierError]() [AuthenticationError]() [AuthorizationError]() [ContextError]() [CriterionError]() [DatabaseError]() [DistinctError]() [FieldError]() [FieldMaskError]() [HeaderError]() [IdError]() [InternalError]() [MutateError]() [NewResourceCreationError]() [NotEmptyError]() [OperatorError]() [QuotaError]() [RangeError]() [RequestError]() [ResourceCountLimitExceededError]() [SizeLimitError]() [StringFormatError]() [StringLengthError]()

    Request object method variants only take one parameter, a request object, which must be constructed before the call.

    • mutateAdGroupBidModifiers(MutateAdGroupBidModifiersRequest request)

    "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

    • mutateAdGroupBidModifiers(String customerId, List<AdGroupBidModifierOperation> operations)

    Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

    • mutateAdGroupBidModifiersCallable()

    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 AdGroupBidModifierServiceSettings to create(). For example:

    To customize credentials: 

    
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 AdGroupBidModifierServiceSettings adGroupBidModifierServiceSettings =
     AdGroupBidModifierServiceSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 AdGroupBidModifierServiceClient adGroupBidModifierServiceClient =
     AdGroupBidModifierServiceClient.create(adGroupBidModifierServiceSettings);

    To customize the endpoint: 

    
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 AdGroupBidModifierServiceSettings adGroupBidModifierServiceSettings =
     AdGroupBidModifierServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
 AdGroupBidModifierServiceClient adGroupBidModifierServiceClient =
     AdGroupBidModifierServiceClient.create(adGroupBidModifierServiceSettings);

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

    • Constructor Detail

      • AdGroupBidModifierServiceClient

        protected AdGroupBidModifierServiceClient​(AdGroupBidModifierServiceSettings settings)
                                   throws java.io.IOException
        Constructs an instance of AdGroupBidModifierServiceClient, 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

    • Method Detail

      • create

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

      • create

        public static final AdGroupBidModifierServiceClient create​(AdGroupBidModifierServiceSettings settings)
                                                    throws java.io.IOException
        Constructs an instance of AdGroupBidModifierServiceClient, using the given settings. The channels are created based on the settings passed in, or defaults for any settings that are not set.
        Throws:
        java.io.IOException

      • mutateAdGroupBidModifiers

        public final MutateAdGroupBidModifiersResponse mutateAdGroupBidModifiers​(java.lang.String customerId,
                                                                         java.util.List<AdGroupBidModifierOperation> operations)
        Creates, updates, or removes ad group bid modifiers. Operation statuses are returned.

        List of thrown errors: [AdGroupBidModifierError]() [AuthenticationError]() [AuthorizationError]() [ContextError]() [CriterionError]() [DatabaseError]() [DistinctError]() [FieldError]() [FieldMaskError]() [HeaderError]() [IdError]() [InternalError]() [MutateError]() [NewResourceCreationError]() [NotEmptyError]() [OperatorError]() [QuotaError]() [RangeError]() [RequestError]() [ResourceCountLimitExceededError]() [SizeLimitError]() [StringFormatError]() [StringLengthError]()

        Sample code: 

        
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AdGroupBidModifierServiceClient adGroupBidModifierServiceClient =
     AdGroupBidModifierServiceClient.create()) {
   String customerId = "customerId-1581184615";
   List<AdGroupBidModifierOperation> operations = new ArrayList<>();
   MutateAdGroupBidModifiersResponse response =
       adGroupBidModifierServiceClient.mutateAdGroupBidModifiers(customerId, operations);
 }
        Parameters:
        customerId - Required. ID of the customer whose ad group bid modifiers are being modified.
        operations - Required. The list of operations to perform on individual ad group bid modifiers.
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails

      • mutateAdGroupBidModifiers

        public final MutateAdGroupBidModifiersResponse mutateAdGroupBidModifiers​(MutateAdGroupBidModifiersRequest request)
        Creates, updates, or removes ad group bid modifiers. Operation statuses are returned.

        List of thrown errors: [AdGroupBidModifierError]() [AuthenticationError]() [AuthorizationError]() [ContextError]() [CriterionError]() [DatabaseError]() [DistinctError]() [FieldError]() [FieldMaskError]() [HeaderError]() [IdError]() [InternalError]() [MutateError]() [NewResourceCreationError]() [NotEmptyError]() [OperatorError]() [QuotaError]() [RangeError]() [RequestError]() [ResourceCountLimitExceededError]() [SizeLimitError]() [StringFormatError]() [StringLengthError]()

        Sample code: 

        
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AdGroupBidModifierServiceClient adGroupBidModifierServiceClient =
     AdGroupBidModifierServiceClient.create()) {
   MutateAdGroupBidModifiersRequest request =
       MutateAdGroupBidModifiersRequest.newBuilder()
           .setCustomerId("customerId-1581184615")
           .addAllOperations(new ArrayList<AdGroupBidModifierOperation>())
           .setPartialFailure(true)
           .setValidateOnly(true)
           .build();
   MutateAdGroupBidModifiersResponse response =
       adGroupBidModifierServiceClient.mutateAdGroupBidModifiers(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

      • mutateAdGroupBidModifiersCallable

        public final com.google.api.gax.rpc.UnaryCallable<MutateAdGroupBidModifiersRequest,​MutateAdGroupBidModifiersResponse> mutateAdGroupBidModifiersCallable()
        Creates, updates, or removes ad group bid modifiers. Operation statuses are returned.

        List of thrown errors: [AdGroupBidModifierError]() [AuthenticationError]() [AuthorizationError]() [ContextError]() [CriterionError]() [DatabaseError]() [DistinctError]() [FieldError]() [FieldMaskError]() [HeaderError]() [IdError]() [InternalError]() [MutateError]() [NewResourceCreationError]() [NotEmptyError]() [OperatorError]() [QuotaError]() [RangeError]() [RequestError]() [ResourceCountLimitExceededError]() [SizeLimitError]() [StringFormatError]() [StringLengthError]()

        Sample code: 

        
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AdGroupBidModifierServiceClient adGroupBidModifierServiceClient =
     AdGroupBidModifierServiceClient.create()) {
   MutateAdGroupBidModifiersRequest request =
       MutateAdGroupBidModifiersRequest.newBuilder()
           .setCustomerId("customerId-1581184615")
           .addAllOperations(new ArrayList<AdGroupBidModifierOperation>())
           .setPartialFailure(true)
           .setValidateOnly(true)
           .build();
   ApiFuture<MutateAdGroupBidModifiersResponse> future =
       adGroupBidModifierServiceClient.mutateAdGroupBidModifiersCallable().futureCall(request);
   // Do something.
   MutateAdGroupBidModifiersResponse 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