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

Class ContentCreatorInsightsServiceClient

java.lang.Object
com.google.ads.googleads.v18.services.ContentCreatorInsightsServiceClient
All Implemented Interfaces:
com.google.api.gax.core.BackgroundResource, AutoCloseable
@Generated("by gapic-generator-java") public class ContentCreatorInsightsServiceClient extends Object implements com.google.api.gax.core.BackgroundResource
Service Description: Content Creator Insights Service helps users find information about YouTube Creators and their content and how these creators and their audiences can be reached with Google Ads. Accessible to allowlisted customers only.

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 (ContentCreatorInsightsServiceClient contentCreatorInsightsServiceClient =
     ContentCreatorInsightsServiceClient.create()) {
   GenerateCreatorInsightsRequest request =
       GenerateCreatorInsightsRequest.newBuilder()
           .setCustomerId("customerId-1581184615")
           .setCustomerInsightsGroup("customerInsightsGroup1092118566")
           .build();
   GenerateCreatorInsightsResponse response =
       contentCreatorInsightsServiceClient.generateCreatorInsights(request);
 }

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

GenerateCreatorInsights

Returns insights for a collection of YouTube Creators and Channels.

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

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

  • generateCreatorInsights(GenerateCreatorInsightsRequest request)

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

  • generateCreatorInsightsCallable()

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 ContentCreatorInsightsServiceSettings 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
 ContentCreatorInsightsServiceSettings contentCreatorInsightsServiceSettings =
     ContentCreatorInsightsServiceSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 ContentCreatorInsightsServiceClient contentCreatorInsightsServiceClient =
     ContentCreatorInsightsServiceClient.create(contentCreatorInsightsServiceSettings);

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
 ContentCreatorInsightsServiceSettings contentCreatorInsightsServiceSettings =
     ContentCreatorInsightsServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
 ContentCreatorInsightsServiceClient contentCreatorInsightsServiceClient =
     ContentCreatorInsightsServiceClient.create(contentCreatorInsightsServiceSettings);

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

  • Constructor Details

    • ContentCreatorInsightsServiceClient

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

    • ContentCreatorInsightsServiceClient

      protected ContentCreatorInsightsServiceClient(ContentCreatorInsightsServiceStub stub)

  • Method Details

    • create

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

    • create

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

    • getSettings

      public final ContentCreatorInsightsServiceSettings getSettings()

    • getStub

      public ContentCreatorInsightsServiceStub getStub()

    • generateCreatorInsights

      public final GenerateCreatorInsightsResponse generateCreatorInsights(GenerateCreatorInsightsRequest request)
      Returns insights for a collection of YouTube Creators and Channels.

      List of thrown errors: [AuthenticationError]() [AuthorizationError]() [FieldError]() [HeaderError]() [InternalError]() [QuotaError]() [RangeError]() [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 (ContentCreatorInsightsServiceClient contentCreatorInsightsServiceClient =
     ContentCreatorInsightsServiceClient.create()) {
   GenerateCreatorInsightsRequest request =
       GenerateCreatorInsightsRequest.newBuilder()
           .setCustomerId("customerId-1581184615")
           .setCustomerInsightsGroup("customerInsightsGroup1092118566")
           .build();
   GenerateCreatorInsightsResponse response =
       contentCreatorInsightsServiceClient.generateCreatorInsights(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

    • generateCreatorInsightsCallable

      public final com.google.api.gax.rpc.UnaryCallable<GenerateCreatorInsightsRequest,GenerateCreatorInsightsResponse> generateCreatorInsightsCallable()
      Returns insights for a collection of YouTube Creators and Channels.

      List of thrown errors: [AuthenticationError]() [AuthorizationError]() [FieldError]() [HeaderError]() [InternalError]() [QuotaError]() [RangeError]() [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 (ContentCreatorInsightsServiceClient contentCreatorInsightsServiceClient =
     ContentCreatorInsightsServiceClient.create()) {
   GenerateCreatorInsightsRequest request =
       GenerateCreatorInsightsRequest.newBuilder()
           .setCustomerId("customerId-1581184615")
           .setCustomerInsightsGroup("customerInsightsGroup1092118566")
           .build();
   ApiFuture<GenerateCreatorInsightsResponse> future =
       contentCreatorInsightsServiceClient.generateCreatorInsightsCallable().futureCall(request);
   // Do something.
   GenerateCreatorInsightsResponse 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