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

Class KeywordViewServiceClient

  • All Implemented Interfaces:
    com.google.api.gax.core.BackgroundResource, java.lang.AutoCloseable
    @Generated("by gapic-generator-java")
public class KeywordViewServiceClient
extends java.lang.Object
implements com.google.api.gax.core.BackgroundResource
    Service Description: Service to manage keyword 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 (KeywordViewServiceClient keywordViewServiceClient = KeywordViewServiceClient.create()) {
   KeywordViewName resourceName =
       KeywordViewName.of("[CUSTOMER_ID]", "[AD_GROUP_ID]", "[CRITERION_ID]");
   KeywordView response = keywordViewServiceClient.getKeywordView(resourceName);
 }

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

    To customize credentials: 

    
 KeywordViewServiceSettings keywordViewServiceSettings =
     KeywordViewServiceSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 KeywordViewServiceClient keywordViewServiceClient =
     KeywordViewServiceClient.create(keywordViewServiceSettings);

    To customize the endpoint: 

    
 KeywordViewServiceSettings keywordViewServiceSettings =
     KeywordViewServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
 KeywordViewServiceClient keywordViewServiceClient =
     KeywordViewServiceClient.create(keywordViewServiceSettings);

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

    • Constructor Detail

      • KeywordViewServiceClient

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

      • KeywordViewServiceClient

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

    • Method Detail

      • create

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

      • create

        public static final KeywordViewServiceClient create​(KeywordViewServiceSettings settings)
                                             throws java.io.IOException
        Constructs an instance of KeywordViewServiceClient, 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 KeywordViewServiceClient create​(KeywordViewServiceStub stub)
        Constructs an instance of KeywordViewServiceClient, using the given stub for making calls. This is for advanced usage - prefer using create(KeywordViewServiceSettings).

      • getStub

        @BetaApi("A restructuring of stub classes is planned, so this may break in the future")
public KeywordViewServiceStub getStub()

      • getKeywordView

        public final KeywordView getKeywordView​(KeywordViewName resourceName)
        Returns the requested keyword view in full detail.

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

        Sample code: 

        
 try (KeywordViewServiceClient keywordViewServiceClient = KeywordViewServiceClient.create()) {
   KeywordViewName resourceName =
       KeywordViewName.of("[CUSTOMER_ID]", "[AD_GROUP_ID]", "[CRITERION_ID]");
   KeywordView response = keywordViewServiceClient.getKeywordView(resourceName);
 }
        Parameters:
        resourceName - Required. The resource name of the keyword view to fetch.
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails

      • getKeywordView

        public final KeywordView getKeywordView​(java.lang.String resourceName)
        Returns the requested keyword view in full detail.

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

        Sample code: 

        
 try (KeywordViewServiceClient keywordViewServiceClient = KeywordViewServiceClient.create()) {
   String resourceName =
       KeywordViewName.of("[CUSTOMER_ID]", "[AD_GROUP_ID]", "[CRITERION_ID]").toString();
   KeywordView response = keywordViewServiceClient.getKeywordView(resourceName);
 }
        Parameters:
        resourceName - Required. The resource name of the keyword view to fetch.
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails

      • getKeywordView

        public final KeywordView getKeywordView​(GetKeywordViewRequest request)
        Returns the requested keyword view in full detail.

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

        Sample code: 

        
 try (KeywordViewServiceClient keywordViewServiceClient = KeywordViewServiceClient.create()) {
   GetKeywordViewRequest request =
       GetKeywordViewRequest.newBuilder()
           .setResourceName(
               KeywordViewName.of("[CUSTOMER_ID]", "[AD_GROUP_ID]", "[CRITERION_ID]").toString())
           .build();
   KeywordView response = keywordViewServiceClient.getKeywordView(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

      • getKeywordViewCallable

        public final com.google.api.gax.rpc.UnaryCallable<GetKeywordViewRequest,​KeywordView> getKeywordViewCallable()
        Returns the requested keyword view in full detail.

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

        Sample code: 

        
 try (KeywordViewServiceClient keywordViewServiceClient = KeywordViewServiceClient.create()) {
   GetKeywordViewRequest request =
       GetKeywordViewRequest.newBuilder()
           .setResourceName(
               KeywordViewName.of("[CUSTOMER_ID]", "[AD_GROUP_ID]", "[CRITERION_ID]").toString())
           .build();
   ApiFuture<KeywordView> future =
       keywordViewServiceClient.getKeywordViewCallable().futureCall(request);
   // Do something.
   KeywordView 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