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

Class FeedItemSetServiceClient

java.lang.Object
com.google.ads.googleads.v18.services.FeedItemSetServiceClient
All Implemented Interfaces:
com.google.api.gax.core.BackgroundResource, AutoCloseable
@Generated("by gapic-generator-java") public class FeedItemSetServiceClient extends Object implements com.google.api.gax.core.BackgroundResource
Service Description: Service to manage feed Item Set

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 (FeedItemSetServiceClient feedItemSetServiceClient = FeedItemSetServiceClient.create()) {
   String customerId = "customerId-1581184615";
   List<FeedItemSetOperation> operations = new ArrayList<>();
   MutateFeedItemSetsResponse response =
       feedItemSetServiceClient.mutateFeedItemSets(customerId, operations);
 }

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

MutateFeedItemSets

Creates, updates or removes feed item sets. Operation statuses are returned.

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

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

  • mutateFeedItemSets(MutateFeedItemSetsRequest request)

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

  • mutateFeedItemSets(String customerId, List<FeedItemSetOperation> operations)

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

  • mutateFeedItemSetsCallable()

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 FeedItemSetServiceSettings 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
 FeedItemSetServiceSettings feedItemSetServiceSettings =
     FeedItemSetServiceSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 FeedItemSetServiceClient feedItemSetServiceClient =
     FeedItemSetServiceClient.create(feedItemSetServiceSettings);

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
 FeedItemSetServiceSettings feedItemSetServiceSettings =
     FeedItemSetServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
 FeedItemSetServiceClient feedItemSetServiceClient =
     FeedItemSetServiceClient.create(feedItemSetServiceSettings);

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

  • Constructor Details

    • FeedItemSetServiceClient

      protected FeedItemSetServiceClient(FeedItemSetServiceSettings settings) throws IOException
      Constructs an instance of FeedItemSetServiceClient, 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

    • FeedItemSetServiceClient

      protected FeedItemSetServiceClient(FeedItemSetServiceStub stub)

  • Method Details

    • create

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

    • create

      public static final FeedItemSetServiceClient create(FeedItemSetServiceSettings settings) throws IOException
      Constructs an instance of FeedItemSetServiceClient, 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 FeedItemSetServiceClient create(FeedItemSetServiceStub stub)
      Constructs an instance of FeedItemSetServiceClient, using the given stub for making calls. This is for advanced usage - prefer using create(FeedItemSetServiceSettings).

    • getSettings

      public final FeedItemSetServiceSettings getSettings()

    • getStub

      public FeedItemSetServiceStub getStub()

    • mutateFeedItemSets

      public final MutateFeedItemSetsResponse mutateFeedItemSets(String customerId, List<FeedItemSetOperation> operations)
      Creates, updates or removes feed item sets. Operation statuses are returned.

      List of thrown errors: [AuthenticationError]() [AuthorizationError]() [HeaderError]() [InternalError]() [MutateError]() [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 (FeedItemSetServiceClient feedItemSetServiceClient = FeedItemSetServiceClient.create()) {
   String customerId = "customerId-1581184615";
   List<FeedItemSetOperation> operations = new ArrayList<>();
   MutateFeedItemSetsResponse response =
       feedItemSetServiceClient.mutateFeedItemSets(customerId, operations);
 }
      Parameters:
      customerId - Required. The ID of the customer whose feed item sets are being modified.
      operations - Required. The list of operations to perform on individual feed item sets.
      Throws:
      com.google.api.gax.rpc.ApiException - if the remote call fails

    • mutateFeedItemSets

      public final MutateFeedItemSetsResponse mutateFeedItemSets(MutateFeedItemSetsRequest request)
      Creates, updates or removes feed item sets. Operation statuses are returned.

      List of thrown errors: [AuthenticationError]() [AuthorizationError]() [HeaderError]() [InternalError]() [MutateError]() [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 (FeedItemSetServiceClient feedItemSetServiceClient = FeedItemSetServiceClient.create()) {
   MutateFeedItemSetsRequest request =
       MutateFeedItemSetsRequest.newBuilder()
           .setCustomerId("customerId-1581184615")
           .addAllOperations(new ArrayList<FeedItemSetOperation>())
           .setPartialFailure(true)
           .setValidateOnly(true)
           .build();
   MutateFeedItemSetsResponse response = feedItemSetServiceClient.mutateFeedItemSets(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

    • mutateFeedItemSetsCallable

      public final com.google.api.gax.rpc.UnaryCallable<MutateFeedItemSetsRequest,MutateFeedItemSetsResponse> mutateFeedItemSetsCallable()
      Creates, updates or removes feed item sets. Operation statuses are returned.

      List of thrown errors: [AuthenticationError]() [AuthorizationError]() [HeaderError]() [InternalError]() [MutateError]() [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 (FeedItemSetServiceClient feedItemSetServiceClient = FeedItemSetServiceClient.create()) {
   MutateFeedItemSetsRequest request =
       MutateFeedItemSetsRequest.newBuilder()
           .setCustomerId("customerId-1581184615")
           .addAllOperations(new ArrayList<FeedItemSetOperation>())
           .setPartialFailure(true)
           .setValidateOnly(true)
           .build();
   ApiFuture<MutateFeedItemSetsResponse> future =
       feedItemSetServiceClient.mutateFeedItemSetsCallable().futureCall(request);
   // Do something.
   MutateFeedItemSetsResponse 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