Class AdUnitServiceClient (0.4.0)

Service Description: Provides methods for handling AdUnit objects.

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 (AdUnitServiceClient adUnitServiceClient = AdUnitServiceClient.create()) {
   AdUnitName name = AdUnitName.of("[NETWORK_CODE]", "[AD_UNIT]");
   AdUnit response = adUnitServiceClient.getAdUnit(name);
 }
 

Note: close() needs to be called on the AdUnitServiceClient object to clean up resources such as threads. In the example above, try-with-resources is used, which automatically calls close().

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 AdUnitServiceSettings 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
 AdUnitServiceSettings adUnitServiceSettings =
     AdUnitServiceSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 AdUnitServiceClient adUnitServiceClient = AdUnitServiceClient.create(adUnitServiceSettings);
 

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
 AdUnitServiceSettings adUnitServiceSettings =
     AdUnitServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
 AdUnitServiceClient adUnitServiceClient = AdUnitServiceClient.create(adUnitServiceSettings);
 

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

Constructs an instance of AdUnitServiceClient with default settings.

Constructs an instance of AdUnitServiceClient, using the given settings. The channels are created based on the settings passed in, or defaults for any settings that are not set.

Constructs an instance of AdUnitServiceClient, using the given stub for making calls. This is for advanced usage - prefer using create(AdUnitServiceSettings).

Constructs an instance of AdUnitServiceClient, 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.

API to retrieve an AdUnit object.

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 (AdUnitServiceClient adUnitServiceClient = AdUnitServiceClient.create()) {
   AdUnitName name = AdUnitName.of("[NETWORK_CODE]", "[AD_UNIT]");
   AdUnit response = adUnitServiceClient.getAdUnit(name);
 }
 

API to retrieve an AdUnit object.

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 (AdUnitServiceClient adUnitServiceClient = AdUnitServiceClient.create()) {
   GetAdUnitRequest request =
       GetAdUnitRequest.newBuilder()
           .setName(AdUnitName.of("[NETWORK_CODE]", "[AD_UNIT]").toString())
           .build();
   AdUnit response = adUnitServiceClient.getAdUnit(request);
 }
 

API to retrieve an AdUnit object.

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 (AdUnitServiceClient adUnitServiceClient = AdUnitServiceClient.create()) {
   String name = AdUnitName.of("[NETWORK_CODE]", "[AD_UNIT]").toString();
   AdUnit response = adUnitServiceClient.getAdUnit(name);
 }
 

API to retrieve an AdUnit object.

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 (AdUnitServiceClient adUnitServiceClient = AdUnitServiceClient.create()) {
   GetAdUnitRequest request =
       GetAdUnitRequest.newBuilder()
           .setName(AdUnitName.of("[NETWORK_CODE]", "[AD_UNIT]").toString())
           .build();
   ApiFuture<AdUnit> future = adUnitServiceClient.getAdUnitCallable().futureCall(request);
   // Do something.
   AdUnit response = future.get();
 }
 

API to retrieve a list of AdUnit objects.

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 (AdUnitServiceClient adUnitServiceClient = AdUnitServiceClient.create()) {
   ListAdUnitsRequest request =
       ListAdUnitsRequest.newBuilder()
           .setParent(NetworkName.of("[NETWORK_CODE]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .setOrderBy("orderBy-1207110587")
           .setSkip(3532159)
           .build();
   for (AdUnit element : adUnitServiceClient.listAdUnits(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

API to retrieve a list of AdUnit objects.

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 (AdUnitServiceClient adUnitServiceClient = AdUnitServiceClient.create()) {
   NetworkName parent = NetworkName.of("[NETWORK_CODE]");
   for (AdUnit element : adUnitServiceClient.listAdUnits(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

API to retrieve a list of AdUnit objects.

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 (AdUnitServiceClient adUnitServiceClient = AdUnitServiceClient.create()) {
   String parent = NetworkName.of("[NETWORK_CODE]").toString();
   for (AdUnit element : adUnitServiceClient.listAdUnits(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

API to retrieve a list of AdUnit objects.

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 (AdUnitServiceClient adUnitServiceClient = AdUnitServiceClient.create()) {
   ListAdUnitsRequest request =
       ListAdUnitsRequest.newBuilder()
           .setParent(NetworkName.of("[NETWORK_CODE]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .setOrderBy("orderBy-1207110587")
           .setSkip(3532159)
           .build();
   while (true) {
     ListAdUnitsResponse response = adUnitServiceClient.listAdUnitsCallable().call(request);
     for (AdUnit element : response.getAdUnitsList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
 

API to retrieve a list of AdUnit objects.

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 (AdUnitServiceClient adUnitServiceClient = AdUnitServiceClient.create()) {
   ListAdUnitsRequest request =
       ListAdUnitsRequest.newBuilder()
           .setParent(NetworkName.of("[NETWORK_CODE]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .setOrderBy("orderBy-1207110587")
           .setSkip(3532159)
           .build();
   ApiFuture<AdUnit> future = adUnitServiceClient.listAdUnitsPagedCallable().futureCall(request);
   // Do something.
   for (AdUnit element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }