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

Class AdGroupLabelServiceClient

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

    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 (AdGroupLabelServiceClient adGroupLabelServiceClient = AdGroupLabelServiceClient.create()) {
   String customerId = "customerId-1581184615";
   List<AdGroupLabelOperation> operations = new ArrayList<>();
   MutateAdGroupLabelsResponse response =
       adGroupLabelServiceClient.mutateAdGroupLabels(customerId, operations);
 }

    Note: close() needs to be called on the AdGroupLabelServiceClient 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

    MutateAdGroupLabels

    Creates and removes ad group labels. Operation statuses are returned.

    List of thrown errors: [AuthenticationError]() [AuthorizationError]() [DatabaseError]() [FieldError]() [HeaderError]() [InternalError]() [LabelError]() [MutateError]() [NewResourceCreationError]() [QuotaError]() [RequestError]()

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

    • mutateAdGroupLabels(MutateAdGroupLabelsRequest request)

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

    • mutateAdGroupLabels(String customerId, List<AdGroupLabelOperation> operations)

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

    • mutateAdGroupLabelsCallable()

    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 AdGroupLabelServiceSettings 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
 AdGroupLabelServiceSettings adGroupLabelServiceSettings =
     AdGroupLabelServiceSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 AdGroupLabelServiceClient adGroupLabelServiceClient =
     AdGroupLabelServiceClient.create(adGroupLabelServiceSettings);

    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
 AdGroupLabelServiceSettings adGroupLabelServiceSettings =
     AdGroupLabelServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
 AdGroupLabelServiceClient adGroupLabelServiceClient =
     AdGroupLabelServiceClient.create(adGroupLabelServiceSettings);

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

    • Constructor Detail

      • AdGroupLabelServiceClient

        protected AdGroupLabelServiceClient​(AdGroupLabelServiceSettings settings)
                             throws java.io.IOException
        Constructs an instance of AdGroupLabelServiceClient, 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 AdGroupLabelServiceClient create()
                                              throws java.io.IOException
        Constructs an instance of AdGroupLabelServiceClient with default settings.
        Throws:
        java.io.IOException

      • create

        public static final AdGroupLabelServiceClient create​(AdGroupLabelServiceSettings settings)
                                              throws java.io.IOException
        Constructs an instance of AdGroupLabelServiceClient, 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

      • create

        public static final AdGroupLabelServiceClient create​(AdGroupLabelServiceStub stub)
        Constructs an instance of AdGroupLabelServiceClient, using the given stub for making calls. This is for advanced usage - prefer using create(AdGroupLabelServiceSettings).

      • mutateAdGroupLabels

        public final MutateAdGroupLabelsResponse mutateAdGroupLabels​(java.lang.String customerId,
                                                             java.util.List<AdGroupLabelOperation> operations)
        Creates and removes ad group labels. Operation statuses are returned.

        List of thrown errors: [AuthenticationError]() [AuthorizationError]() [DatabaseError]() [FieldError]() [HeaderError]() [InternalError]() [LabelError]() [MutateError]() [NewResourceCreationError]() [QuotaError]() [RequestError]()

        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 (AdGroupLabelServiceClient adGroupLabelServiceClient = AdGroupLabelServiceClient.create()) {
   String customerId = "customerId-1581184615";
   List<AdGroupLabelOperation> operations = new ArrayList<>();
   MutateAdGroupLabelsResponse response =
       adGroupLabelServiceClient.mutateAdGroupLabels(customerId, operations);
 }
        Parameters:
        customerId - Required. ID of the customer whose ad group labels are being modified.
        operations - Required. The list of operations to perform on ad group labels.
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails

      • mutateAdGroupLabels

        public final MutateAdGroupLabelsResponse mutateAdGroupLabels​(MutateAdGroupLabelsRequest request)
        Creates and removes ad group labels. Operation statuses are returned.

        List of thrown errors: [AuthenticationError]() [AuthorizationError]() [DatabaseError]() [FieldError]() [HeaderError]() [InternalError]() [LabelError]() [MutateError]() [NewResourceCreationError]() [QuotaError]() [RequestError]()

        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 (AdGroupLabelServiceClient adGroupLabelServiceClient = AdGroupLabelServiceClient.create()) {
   MutateAdGroupLabelsRequest request =
       MutateAdGroupLabelsRequest.newBuilder()
           .setCustomerId("customerId-1581184615")
           .addAllOperations(new ArrayList<AdGroupLabelOperation>())
           .setPartialFailure(true)
           .setValidateOnly(true)
           .build();
   MutateAdGroupLabelsResponse response = adGroupLabelServiceClient.mutateAdGroupLabels(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

      • mutateAdGroupLabelsCallable

        public final com.google.api.gax.rpc.UnaryCallable<MutateAdGroupLabelsRequest,​MutateAdGroupLabelsResponse> mutateAdGroupLabelsCallable()
        Creates and removes ad group labels. Operation statuses are returned.

        List of thrown errors: [AuthenticationError]() [AuthorizationError]() [DatabaseError]() [FieldError]() [HeaderError]() [InternalError]() [LabelError]() [MutateError]() [NewResourceCreationError]() [QuotaError]() [RequestError]()

        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 (AdGroupLabelServiceClient adGroupLabelServiceClient = AdGroupLabelServiceClient.create()) {
   MutateAdGroupLabelsRequest request =
       MutateAdGroupLabelsRequest.newBuilder()
           .setCustomerId("customerId-1581184615")
           .addAllOperations(new ArrayList<AdGroupLabelOperation>())
           .setPartialFailure(true)
           .setValidateOnly(true)
           .build();
   ApiFuture<MutateAdGroupLabelsResponse> future =
       adGroupLabelServiceClient.mutateAdGroupLabelsCallable().futureCall(request);
   // Do something.
   MutateAdGroupLabelsResponse 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