Package com.google.ads.googleads.v18.services

Class SmartCampaignSettingServiceClient

java.lang.Object
com.google.ads.googleads.v18.services.SmartCampaignSettingServiceClient
All Implemented Interfaces:
com.google.api.gax.core.BackgroundResource, AutoCloseable
@Generated("by gapic-generator-java") public class SmartCampaignSettingServiceClient extends Object implements com.google.api.gax.core.BackgroundResource
Service Description: Service to manage Smart campaign 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 (SmartCampaignSettingServiceClient smartCampaignSettingServiceClient =
     SmartCampaignSettingServiceClient.create()) {
   SmartCampaignSettingName resourceName =
       SmartCampaignSettingName.of("[CUSTOMER_ID]", "[CAMPAIGN_ID]");
   GetSmartCampaignStatusResponse response =
       smartCampaignSettingServiceClient.getSmartCampaignStatus(resourceName);
 }

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

GetSmartCampaignStatus

Returns the status of the requested Smart campaign.

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

  • getSmartCampaignStatus(GetSmartCampaignStatusRequest request)

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

  • getSmartCampaignStatus(SmartCampaignSettingName resourceName)

  • getSmartCampaignStatus(String resourceName)

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

  • getSmartCampaignStatusCallable()

MutateSmartCampaignSettings

Updates Smart campaign settings for campaigns.

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

  • mutateSmartCampaignSettings(MutateSmartCampaignSettingsRequest request)

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

  • mutateSmartCampaignSettings(String customerId, List<SmartCampaignSettingOperation> operations)

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

  • mutateSmartCampaignSettingsCallable()

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 SmartCampaignSettingServiceSettings 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
 SmartCampaignSettingServiceSettings smartCampaignSettingServiceSettings =
     SmartCampaignSettingServiceSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 SmartCampaignSettingServiceClient smartCampaignSettingServiceClient =
     SmartCampaignSettingServiceClient.create(smartCampaignSettingServiceSettings);

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
 SmartCampaignSettingServiceSettings smartCampaignSettingServiceSettings =
     SmartCampaignSettingServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
 SmartCampaignSettingServiceClient smartCampaignSettingServiceClient =
     SmartCampaignSettingServiceClient.create(smartCampaignSettingServiceSettings);

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

  • Constructor Details

    • SmartCampaignSettingServiceClient

      protected SmartCampaignSettingServiceClient(SmartCampaignSettingServiceSettings settings) throws IOException
      Constructs an instance of SmartCampaignSettingServiceClient, 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:
      IOException

    • SmartCampaignSettingServiceClient

      protected SmartCampaignSettingServiceClient(SmartCampaignSettingServiceStub stub)

  • Method Details

    • create

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

    • create

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

    • create

      public static final SmartCampaignSettingServiceClient create(SmartCampaignSettingServiceStub stub)
      Constructs an instance of SmartCampaignSettingServiceClient, using the given stub for making calls. This is for advanced usage - prefer using create(SmartCampaignSettingServiceSettings).

    • getSettings

      public final SmartCampaignSettingServiceSettings getSettings()

    • getStub

      public SmartCampaignSettingServiceStub getStub()

    • getSmartCampaignStatus

      public final GetSmartCampaignStatusResponse getSmartCampaignStatus(SmartCampaignSettingName resourceName)
      Returns the status of the requested Smart campaign.

      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 (SmartCampaignSettingServiceClient smartCampaignSettingServiceClient =
     SmartCampaignSettingServiceClient.create()) {
   SmartCampaignSettingName resourceName =
       SmartCampaignSettingName.of("[CUSTOMER_ID]", "[CAMPAIGN_ID]");
   GetSmartCampaignStatusResponse response =
       smartCampaignSettingServiceClient.getSmartCampaignStatus(resourceName);
 }
      Parameters:
      resourceName - Required. The resource name of the Smart campaign setting belonging to the Smart campaign to fetch the status of.
      Throws:
      com.google.api.gax.rpc.ApiException - if the remote call fails

    • getSmartCampaignStatus

      public final GetSmartCampaignStatusResponse getSmartCampaignStatus(String resourceName)
      Returns the status of the requested Smart campaign.

      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 (SmartCampaignSettingServiceClient smartCampaignSettingServiceClient =
     SmartCampaignSettingServiceClient.create()) {
   String resourceName =
       SmartCampaignSettingName.of("[CUSTOMER_ID]", "[CAMPAIGN_ID]").toString();
   GetSmartCampaignStatusResponse response =
       smartCampaignSettingServiceClient.getSmartCampaignStatus(resourceName);
 }
      Parameters:
      resourceName - Required. The resource name of the Smart campaign setting belonging to the Smart campaign to fetch the status of.
      Throws:
      com.google.api.gax.rpc.ApiException - if the remote call fails

    • getSmartCampaignStatus

      public final GetSmartCampaignStatusResponse getSmartCampaignStatus(GetSmartCampaignStatusRequest request)
      Returns the status of the requested Smart campaign.

      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 (SmartCampaignSettingServiceClient smartCampaignSettingServiceClient =
     SmartCampaignSettingServiceClient.create()) {
   GetSmartCampaignStatusRequest request =
       GetSmartCampaignStatusRequest.newBuilder()
           .setResourceName(
               SmartCampaignSettingName.of("[CUSTOMER_ID]", "[CAMPAIGN_ID]").toString())
           .build();
   GetSmartCampaignStatusResponse response =
       smartCampaignSettingServiceClient.getSmartCampaignStatus(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

    • getSmartCampaignStatusCallable

      public final com.google.api.gax.rpc.UnaryCallable<GetSmartCampaignStatusRequest,GetSmartCampaignStatusResponse> getSmartCampaignStatusCallable()
      Returns the status of the requested Smart campaign.

      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 (SmartCampaignSettingServiceClient smartCampaignSettingServiceClient =
     SmartCampaignSettingServiceClient.create()) {
   GetSmartCampaignStatusRequest request =
       GetSmartCampaignStatusRequest.newBuilder()
           .setResourceName(
               SmartCampaignSettingName.of("[CUSTOMER_ID]", "[CAMPAIGN_ID]").toString())
           .build();
   ApiFuture<GetSmartCampaignStatusResponse> future =
       smartCampaignSettingServiceClient.getSmartCampaignStatusCallable().futureCall(request);
   // Do something.
   GetSmartCampaignStatusResponse response = future.get();
 }

    • mutateSmartCampaignSettings

      public final MutateSmartCampaignSettingsResponse mutateSmartCampaignSettings(String customerId, List<SmartCampaignSettingOperation> operations)
      Updates Smart campaign settings for campaigns.

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

    • mutateSmartCampaignSettings

      public final MutateSmartCampaignSettingsResponse mutateSmartCampaignSettings(MutateSmartCampaignSettingsRequest request)
      Updates Smart campaign settings for campaigns.

      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 (SmartCampaignSettingServiceClient smartCampaignSettingServiceClient =
     SmartCampaignSettingServiceClient.create()) {
   MutateSmartCampaignSettingsRequest request =
       MutateSmartCampaignSettingsRequest.newBuilder()
           .setCustomerId("customerId-1581184615")
           .addAllOperations(new ArrayList<SmartCampaignSettingOperation>())
           .setPartialFailure(true)
           .setValidateOnly(true)
           .build();
   MutateSmartCampaignSettingsResponse response =
       smartCampaignSettingServiceClient.mutateSmartCampaignSettings(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

    • mutateSmartCampaignSettingsCallable

      public final com.google.api.gax.rpc.UnaryCallable<MutateSmartCampaignSettingsRequest,MutateSmartCampaignSettingsResponse> mutateSmartCampaignSettingsCallable()
      Updates Smart campaign settings for campaigns.

      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 (SmartCampaignSettingServiceClient smartCampaignSettingServiceClient =
     SmartCampaignSettingServiceClient.create()) {
   MutateSmartCampaignSettingsRequest request =
       MutateSmartCampaignSettingsRequest.newBuilder()
           .setCustomerId("customerId-1581184615")
           .addAllOperations(new ArrayList<SmartCampaignSettingOperation>())
           .setPartialFailure(true)
           .setValidateOnly(true)
           .build();
   ApiFuture<MutateSmartCampaignSettingsResponse> future =
       smartCampaignSettingServiceClient
           .mutateSmartCampaignSettingsCallable()
           .futureCall(request);
   // Do something.
   MutateSmartCampaignSettingsResponse response = future.get();
 }

    • close

      public final void close()
      Specified by:
      close in interface 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, TimeUnit unit) throws InterruptedException
      Specified by:
      awaitTermination in interface com.google.api.gax.core.BackgroundResource
      Throws:
      InterruptedException