Package com.google.ads.googleads.v9.services

Class ShoppingPerformanceViewServiceClient

  • All Implemented Interfaces:
    com.google.api.gax.core.BackgroundResource, java.lang.AutoCloseable
    @Generated("by gapic-generator-java")
public class ShoppingPerformanceViewServiceClient
extends java.lang.Object
implements com.google.api.gax.core.BackgroundResource
    Service Description: Service to fetch Shopping performance views.

    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: 

    
 try (ShoppingPerformanceViewServiceClient shoppingPerformanceViewServiceClient =
     ShoppingPerformanceViewServiceClient.create()) {
   ShoppingPerformanceViewName resourceName = ShoppingPerformanceViewName.of("[CUSTOMER_ID]");
   ShoppingPerformanceView response =
       shoppingPerformanceViewServiceClient.getShoppingPerformanceView(resourceName);
 }

    Note: close() needs to be called on the ShoppingPerformanceViewServiceClient 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 ShoppingPerformanceViewServiceSettings to create(). For example:

    To customize credentials: 

    
 ShoppingPerformanceViewServiceSettings shoppingPerformanceViewServiceSettings =
     ShoppingPerformanceViewServiceSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 ShoppingPerformanceViewServiceClient shoppingPerformanceViewServiceClient =
     ShoppingPerformanceViewServiceClient.create(shoppingPerformanceViewServiceSettings);

    To customize the endpoint: 

    
 ShoppingPerformanceViewServiceSettings shoppingPerformanceViewServiceSettings =
     ShoppingPerformanceViewServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
 ShoppingPerformanceViewServiceClient shoppingPerformanceViewServiceClient =
     ShoppingPerformanceViewServiceClient.create(shoppingPerformanceViewServiceSettings);

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

    • Constructor Detail

      • ShoppingPerformanceViewServiceClient

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

      • ShoppingPerformanceViewServiceClient

        @BetaApi("A restructuring of stub classes is planned, so this may break in the future")
protected ShoppingPerformanceViewServiceClient​(ShoppingPerformanceViewServiceStub stub)

    • Method Detail

      • create

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

      • create

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

        @BetaApi("A restructuring of stub classes is planned, so this may break in the future")
public static final ShoppingPerformanceViewServiceClient create​(ShoppingPerformanceViewServiceStub stub)
        Constructs an instance of ShoppingPerformanceViewServiceClient, using the given stub for making calls. This is for advanced usage - prefer using create(ShoppingPerformanceViewServiceSettings).

      • getShoppingPerformanceView

        public final ShoppingPerformanceView getShoppingPerformanceView​(ShoppingPerformanceViewName resourceName)
        Returns the requested Shopping performance view in full detail.

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

        Sample code: 

        
 try (ShoppingPerformanceViewServiceClient shoppingPerformanceViewServiceClient =
     ShoppingPerformanceViewServiceClient.create()) {
   ShoppingPerformanceViewName resourceName = ShoppingPerformanceViewName.of("[CUSTOMER_ID]");
   ShoppingPerformanceView response =
       shoppingPerformanceViewServiceClient.getShoppingPerformanceView(resourceName);
 }
        Parameters:
        resourceName - Required. The resource name of the Shopping performance view to fetch.
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails

      • getShoppingPerformanceView

        public final ShoppingPerformanceView getShoppingPerformanceView​(java.lang.String resourceName)
        Returns the requested Shopping performance view in full detail.

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

        Sample code: 

        
 try (ShoppingPerformanceViewServiceClient shoppingPerformanceViewServiceClient =
     ShoppingPerformanceViewServiceClient.create()) {
   String resourceName = ShoppingPerformanceViewName.of("[CUSTOMER_ID]").toString();
   ShoppingPerformanceView response =
       shoppingPerformanceViewServiceClient.getShoppingPerformanceView(resourceName);
 }
        Parameters:
        resourceName - Required. The resource name of the Shopping performance view to fetch.
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails

      • getShoppingPerformanceView

        public final ShoppingPerformanceView getShoppingPerformanceView​(GetShoppingPerformanceViewRequest request)
        Returns the requested Shopping performance view in full detail.

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

        Sample code: 

        
 try (ShoppingPerformanceViewServiceClient shoppingPerformanceViewServiceClient =
     ShoppingPerformanceViewServiceClient.create()) {
   GetShoppingPerformanceViewRequest request =
       GetShoppingPerformanceViewRequest.newBuilder()
           .setResourceName(ShoppingPerformanceViewName.of("[CUSTOMER_ID]").toString())
           .build();
   ShoppingPerformanceView response =
       shoppingPerformanceViewServiceClient.getShoppingPerformanceView(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

      • getShoppingPerformanceViewCallable

        public final com.google.api.gax.rpc.UnaryCallable<GetShoppingPerformanceViewRequest,​ShoppingPerformanceView> getShoppingPerformanceViewCallable()
        Returns the requested Shopping performance view in full detail.

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

        Sample code: 

        
 try (ShoppingPerformanceViewServiceClient shoppingPerformanceViewServiceClient =
     ShoppingPerformanceViewServiceClient.create()) {
   GetShoppingPerformanceViewRequest request =
       GetShoppingPerformanceViewRequest.newBuilder()
           .setResourceName(ShoppingPerformanceViewName.of("[CUSTOMER_ID]").toString())
           .build();
   ApiFuture<ShoppingPerformanceView> future =
       shoppingPerformanceViewServiceClient
           .getShoppingPerformanceViewCallable()
           .futureCall(request);
   // Do something.
   ShoppingPerformanceView 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