Package com.google.ads.googleads.v13.services

Class CampaignExtensionSettingServiceClient

  • All Implemented Interfaces:
    com.google.api.gax.core.BackgroundResource, java.lang.AutoCloseable
    @Generated("by gapic-generator-java")
public class CampaignExtensionSettingServiceClient
extends java.lang.Object
implements com.google.api.gax.core.BackgroundResource
    Service Description: Service to manage campaign extension settings.

    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 (CampaignExtensionSettingServiceClient campaignExtensionSettingServiceClient =
     CampaignExtensionSettingServiceClient.create()) {
   String customerId = "customerId-1581184615";
   List<CampaignExtensionSettingOperation> operations = new ArrayList<>();
   MutateCampaignExtensionSettingsResponse response =
       campaignExtensionSettingServiceClient.mutateCampaignExtensionSettings(
           customerId, operations);
 }

    Note: close() needs to be called on the CampaignExtensionSettingServiceClient 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 CampaignExtensionSettingServiceSettings 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
 CampaignExtensionSettingServiceSettings campaignExtensionSettingServiceSettings =
     CampaignExtensionSettingServiceSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 CampaignExtensionSettingServiceClient campaignExtensionSettingServiceClient =
     CampaignExtensionSettingServiceClient.create(campaignExtensionSettingServiceSettings);

    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
 CampaignExtensionSettingServiceSettings campaignExtensionSettingServiceSettings =
     CampaignExtensionSettingServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
 CampaignExtensionSettingServiceClient campaignExtensionSettingServiceClient =
     CampaignExtensionSettingServiceClient.create(campaignExtensionSettingServiceSettings);

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

    • Constructor Detail

      • CampaignExtensionSettingServiceClient

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

      • create

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

      • mutateCampaignExtensionSettings

        public final MutateCampaignExtensionSettingsResponse mutateCampaignExtensionSettings​(java.lang.String customerId,
                                                                                     java.util.List<CampaignExtensionSettingOperation> operations)
        Creates, updates, or removes campaign extension settings. Operation statuses are returned.

        List of thrown errors: [AuthenticationError]() [AuthorizationError]() [CollectionSizeError]() [CriterionError]() [DatabaseError]() [DateError]() [DistinctError]() [ExtensionSettingError]() [FieldError]() [FieldMaskError]() [HeaderError]() [IdError]() [InternalError]() [ListOperationError]() [MutateError]() [NewResourceCreationError]() [NotEmptyError]() [NullError]() [OperationAccessDeniedError]() [OperatorError]() [QuotaError]() [RangeError]() [RequestError]() [SizeLimitError]() [StringFormatError]() [StringLengthError]() [UrlFieldError]()

        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 (CampaignExtensionSettingServiceClient campaignExtensionSettingServiceClient =
     CampaignExtensionSettingServiceClient.create()) {
   String customerId = "customerId-1581184615";
   List<CampaignExtensionSettingOperation> operations = new ArrayList<>();
   MutateCampaignExtensionSettingsResponse response =
       campaignExtensionSettingServiceClient.mutateCampaignExtensionSettings(
           customerId, operations);
 }
        Parameters:
        customerId - Required. The ID of the customer whose campaign extension settings are being modified.
        operations - Required. The list of operations to perform on individual campaign extension settings.
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails

      • mutateCampaignExtensionSettings

        public final MutateCampaignExtensionSettingsResponse mutateCampaignExtensionSettings​(MutateCampaignExtensionSettingsRequest request)
        Creates, updates, or removes campaign extension settings. Operation statuses are returned.

        List of thrown errors: [AuthenticationError]() [AuthorizationError]() [CollectionSizeError]() [CriterionError]() [DatabaseError]() [DateError]() [DistinctError]() [ExtensionSettingError]() [FieldError]() [FieldMaskError]() [HeaderError]() [IdError]() [InternalError]() [ListOperationError]() [MutateError]() [NewResourceCreationError]() [NotEmptyError]() [NullError]() [OperationAccessDeniedError]() [OperatorError]() [QuotaError]() [RangeError]() [RequestError]() [SizeLimitError]() [StringFormatError]() [StringLengthError]() [UrlFieldError]()

        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 (CampaignExtensionSettingServiceClient campaignExtensionSettingServiceClient =
     CampaignExtensionSettingServiceClient.create()) {
   MutateCampaignExtensionSettingsRequest request =
       MutateCampaignExtensionSettingsRequest.newBuilder()
           .setCustomerId("customerId-1581184615")
           .addAllOperations(new ArrayList<CampaignExtensionSettingOperation>())
           .setPartialFailure(true)
           .setValidateOnly(true)
           .build();
   MutateCampaignExtensionSettingsResponse response =
       campaignExtensionSettingServiceClient.mutateCampaignExtensionSettings(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

      • mutateCampaignExtensionSettingsCallable

        public final com.google.api.gax.rpc.UnaryCallable<MutateCampaignExtensionSettingsRequest,​MutateCampaignExtensionSettingsResponse> mutateCampaignExtensionSettingsCallable()
        Creates, updates, or removes campaign extension settings. Operation statuses are returned.

        List of thrown errors: [AuthenticationError]() [AuthorizationError]() [CollectionSizeError]() [CriterionError]() [DatabaseError]() [DateError]() [DistinctError]() [ExtensionSettingError]() [FieldError]() [FieldMaskError]() [HeaderError]() [IdError]() [InternalError]() [ListOperationError]() [MutateError]() [NewResourceCreationError]() [NotEmptyError]() [NullError]() [OperationAccessDeniedError]() [OperatorError]() [QuotaError]() [RangeError]() [RequestError]() [SizeLimitError]() [StringFormatError]() [StringLengthError]() [UrlFieldError]()

        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 (CampaignExtensionSettingServiceClient campaignExtensionSettingServiceClient =
     CampaignExtensionSettingServiceClient.create()) {
   MutateCampaignExtensionSettingsRequest request =
       MutateCampaignExtensionSettingsRequest.newBuilder()
           .setCustomerId("customerId-1581184615")
           .addAllOperations(new ArrayList<CampaignExtensionSettingOperation>())
           .setPartialFailure(true)
           .setValidateOnly(true)
           .build();
   ApiFuture<MutateCampaignExtensionSettingsResponse> future =
       campaignExtensionSettingServiceClient
           .mutateCampaignExtensionSettingsCallable()
           .futureCall(request);
   // Do something.
   MutateCampaignExtensionSettingsResponse 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