Package com.google.ads.googleads.v10.services

Class AdServiceClient

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

    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 (AdServiceClient adServiceClient = AdServiceClient.create()) {
   AdName resourceName = AdName.of("[CUSTOMER_ID]", "[AD_ID]");
   Ad response = adServiceClient.getAd(resourceName);
 }

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

    To customize credentials: 

    
 AdServiceSettings adServiceSettings =
     AdServiceSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 AdServiceClient adServiceClient = AdServiceClient.create(adServiceSettings);

    To customize the endpoint: 

    
 AdServiceSettings adServiceSettings =
     AdServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
 AdServiceClient adServiceClient = AdServiceClient.create(adServiceSettings);

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

    • Constructor Detail

      • AdServiceClient

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

      • AdServiceClient

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

    • Method Detail

      • create

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

      • create

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

      • getStub

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

      • getAd

        public final Ad getAd​(AdName resourceName)
        Returns the requested ad in full detail.

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

        Sample code: 

        
 try (AdServiceClient adServiceClient = AdServiceClient.create()) {
   AdName resourceName = AdName.of("[CUSTOMER_ID]", "[AD_ID]");
   Ad response = adServiceClient.getAd(resourceName);
 }
        Parameters:
        resourceName - Required. The resource name of the ad to fetch.
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails

      • getAd

        public final Ad getAd​(java.lang.String resourceName)
        Returns the requested ad in full detail.

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

        Sample code: 

        
 try (AdServiceClient adServiceClient = AdServiceClient.create()) {
   String resourceName = AdName.of("[CUSTOMER_ID]", "[AD_ID]").toString();
   Ad response = adServiceClient.getAd(resourceName);
 }
        Parameters:
        resourceName - Required. The resource name of the ad to fetch.
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails

      • getAd

        public final Ad getAd​(GetAdRequest request)
        Returns the requested ad in full detail.

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

        Sample code: 

        
 try (AdServiceClient adServiceClient = AdServiceClient.create()) {
   GetAdRequest request =
       GetAdRequest.newBuilder()
           .setResourceName(AdName.of("[CUSTOMER_ID]", "[AD_ID]").toString())
           .build();
   Ad response = adServiceClient.getAd(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

      • getAdCallable

        public final com.google.api.gax.rpc.UnaryCallable<GetAdRequest,​Ad> getAdCallable()
        Returns the requested ad in full detail.

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

        Sample code: 

        
 try (AdServiceClient adServiceClient = AdServiceClient.create()) {
   GetAdRequest request =
       GetAdRequest.newBuilder()
           .setResourceName(AdName.of("[CUSTOMER_ID]", "[AD_ID]").toString())
           .build();
   ApiFuture<Ad> future = adServiceClient.getAdCallable().futureCall(request);
   // Do something.
   Ad response = future.get();
 }

      • mutateAds

        public final MutateAdsResponse mutateAds​(java.lang.String customerId,
                                         java.util.List<AdOperation> operations)
        Updates ads. Operation statuses are returned. Updating ads is not supported for TextAd, ExpandedDynamicSearchAd, GmailAd and ImageAd.

        List of thrown errors: [AdCustomizerError]() [AdError]() [AdSharingError]() [AdxError]() [AssetError]() [AssetLinkError]() [AuthenticationError]() [AuthorizationError]() [CollectionSizeError]() [DatabaseError]() [DateError]() [DistinctError]() [FeedAttributeReferenceError]() [FieldError]() [FieldMaskError]() [FunctionError]() [FunctionParsingError]() [HeaderError]() [IdError]() [ImageError]() [InternalError]() [ListOperationError]() [MediaBundleError]() [MediaFileError]() [MutateError]() [NewResourceCreationError]() [NotEmptyError]() [NullError]() [OperatorError]() [PolicyFindingError]() [PolicyViolationError]() [QuotaError]() [RangeError]() [RequestError]() [SizeLimitError]() [StringFormatError]() [StringLengthError]() [UrlFieldError]()

        Sample code: 

        
 try (AdServiceClient adServiceClient = AdServiceClient.create()) {
   String customerId = "customerId-1581184615";
   List<AdOperation> operations = new ArrayList<>();
   MutateAdsResponse response = adServiceClient.mutateAds(customerId, operations);
 }
        Parameters:
        customerId - Required. The ID of the customer whose ads are being modified.
        operations - Required. The list of operations to perform on individual ads.
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails

      • mutateAds

        public final MutateAdsResponse mutateAds​(MutateAdsRequest request)
        Updates ads. Operation statuses are returned. Updating ads is not supported for TextAd, ExpandedDynamicSearchAd, GmailAd and ImageAd.

        List of thrown errors: [AdCustomizerError]() [AdError]() [AdSharingError]() [AdxError]() [AssetError]() [AssetLinkError]() [AuthenticationError]() [AuthorizationError]() [CollectionSizeError]() [DatabaseError]() [DateError]() [DistinctError]() [FeedAttributeReferenceError]() [FieldError]() [FieldMaskError]() [FunctionError]() [FunctionParsingError]() [HeaderError]() [IdError]() [ImageError]() [InternalError]() [ListOperationError]() [MediaBundleError]() [MediaFileError]() [MutateError]() [NewResourceCreationError]() [NotEmptyError]() [NullError]() [OperatorError]() [PolicyFindingError]() [PolicyViolationError]() [QuotaError]() [RangeError]() [RequestError]() [SizeLimitError]() [StringFormatError]() [StringLengthError]() [UrlFieldError]()

        Sample code: 

        
 try (AdServiceClient adServiceClient = AdServiceClient.create()) {
   MutateAdsRequest request =
       MutateAdsRequest.newBuilder()
           .setCustomerId("customerId-1581184615")
           .addAllOperations(new ArrayList<AdOperation>())
           .setPartialFailure(true)
           .setValidateOnly(true)
           .build();
   MutateAdsResponse response = adServiceClient.mutateAds(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

      • mutateAdsCallable

        public final com.google.api.gax.rpc.UnaryCallable<MutateAdsRequest,​MutateAdsResponse> mutateAdsCallable()
        Updates ads. Operation statuses are returned. Updating ads is not supported for TextAd, ExpandedDynamicSearchAd, GmailAd and ImageAd.

        List of thrown errors: [AdCustomizerError]() [AdError]() [AdSharingError]() [AdxError]() [AssetError]() [AssetLinkError]() [AuthenticationError]() [AuthorizationError]() [CollectionSizeError]() [DatabaseError]() [DateError]() [DistinctError]() [FeedAttributeReferenceError]() [FieldError]() [FieldMaskError]() [FunctionError]() [FunctionParsingError]() [HeaderError]() [IdError]() [ImageError]() [InternalError]() [ListOperationError]() [MediaBundleError]() [MediaFileError]() [MutateError]() [NewResourceCreationError]() [NotEmptyError]() [NullError]() [OperatorError]() [PolicyFindingError]() [PolicyViolationError]() [QuotaError]() [RangeError]() [RequestError]() [SizeLimitError]() [StringFormatError]() [StringLengthError]() [UrlFieldError]()

        Sample code: 

        
 try (AdServiceClient adServiceClient = AdServiceClient.create()) {
   MutateAdsRequest request =
       MutateAdsRequest.newBuilder()
           .setCustomerId("customerId-1581184615")
           .addAllOperations(new ArrayList<AdOperation>())
           .setPartialFailure(true)
           .setValidateOnly(true)
           .build();
   ApiFuture<MutateAdsResponse> future = adServiceClient.mutateAdsCallable().futureCall(request);
   // Do something.
   MutateAdsResponse 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