Class CreativeTemplateServiceClient (0.39.0)

Service Description: Provides methods for handling CreativeTemplate 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 (CreativeTemplateServiceClient creativeTemplateServiceClient =
     CreativeTemplateServiceClient.create()) {
   CreativeTemplateName name = CreativeTemplateName.of("[NETWORK_CODE]", "[CREATIVE_TEMPLATE]");
   CreativeTemplate response = creativeTemplateServiceClient.getCreativeTemplate(name);
 }

Note: close() needs to be called on the CreativeTemplateServiceClient 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
GetCreativeTemplate	API to retrieve a `CreativeTemplate` object.	Request object method variants only take one parameter, a request object, which must be constructed before the call. getCreativeTemplate(GetCreativeTemplateRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. getCreativeTemplate(CreativeTemplateName name) getCreativeTemplate(String name) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. getCreativeTemplateCallable()
ListCreativeTemplates	API to retrieve a list of `CreativeTemplate` objects.	Request object method variants only take one parameter, a request object, which must be constructed before the call. listCreativeTemplates(ListCreativeTemplatesRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. listCreativeTemplates(NetworkName parent) listCreativeTemplates(String parent) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. listCreativeTemplatesPagedCallable() listCreativeTemplatesCallable()

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 CreativeTemplateServiceSettings 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
 CreativeTemplateServiceSettings creativeTemplateServiceSettings =
     CreativeTemplateServiceSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 CreativeTemplateServiceClient creativeTemplateServiceClient =
     CreativeTemplateServiceClient.create(creativeTemplateServiceSettings);

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
 CreativeTemplateServiceSettings creativeTemplateServiceSettings =
     CreativeTemplateServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
 CreativeTemplateServiceClient creativeTemplateServiceClient =
     CreativeTemplateServiceClient.create(creativeTemplateServiceSettings);

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

Inheritance

java.lang.Object > CreativeTemplateServiceClient

Static Methods

create()

public static final CreativeTemplateServiceClient create()

Constructs an instance of CreativeTemplateServiceClient with default settings.

Returns
Type	Description
`CreativeTemplateServiceClient`

Exceptions
Type	Description
`IOException`

create(CreativeTemplateServiceSettings settings)

public static final CreativeTemplateServiceClient create(CreativeTemplateServiceSettings settings)

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

Parameter
Name	Description
`settings`	`CreativeTemplateServiceSettings`

Returns
Type	Description
`CreativeTemplateServiceClient`

Exceptions
Type	Description
`IOException`

create(CreativeTemplateServiceStub stub)

public static final CreativeTemplateServiceClient create(CreativeTemplateServiceStub stub)

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

Parameter
Name	Description
`stub`	`CreativeTemplateServiceStub`

Returns
Type	Description
`CreativeTemplateServiceClient`

Constructors

CreativeTemplateServiceClient(CreativeTemplateServiceSettings settings)

protected CreativeTemplateServiceClient(CreativeTemplateServiceSettings settings)

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

Parameter
Name	Description
`settings`	`CreativeTemplateServiceSettings`

CreativeTemplateServiceClient(CreativeTemplateServiceStub stub)

protected CreativeTemplateServiceClient(CreativeTemplateServiceStub stub)

Parameter
Name	Description
`stub`	`CreativeTemplateServiceStub`

Methods

awaitTermination(long duration, TimeUnit unit)

public boolean awaitTermination(long duration, TimeUnit unit)

Parameters
Name	Description
`duration`	`long`
`unit`	`TimeUnit`

Returns
Type	Description
`boolean`

Exceptions
Type	Description
`InterruptedException`

close()

public final void close()

getCreativeTemplate(CreativeTemplateName name)

public final CreativeTemplate getCreativeTemplate(CreativeTemplateName name)

API to retrieve a CreativeTemplate 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 (CreativeTemplateServiceClient creativeTemplateServiceClient =
     CreativeTemplateServiceClient.create()) {
   CreativeTemplateName name = CreativeTemplateName.of("[NETWORK_CODE]", "[CREATIVE_TEMPLATE]");
   CreativeTemplate response = creativeTemplateServiceClient.getCreativeTemplate(name);
 }

Parameter
Name	Description
`name`	`CreativeTemplateName` Required. The resource name of the CreativeTemplate. Format: `networks/{network_code}/creativeTemplates/{creative_template_id}`

Returns
Type	Description
`CreativeTemplate`

getCreativeTemplate(GetCreativeTemplateRequest request)

public final CreativeTemplate getCreativeTemplate(GetCreativeTemplateRequest request)

API to retrieve a CreativeTemplate 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 (CreativeTemplateServiceClient creativeTemplateServiceClient =
     CreativeTemplateServiceClient.create()) {
   GetCreativeTemplateRequest request =
       GetCreativeTemplateRequest.newBuilder()
           .setName(CreativeTemplateName.of("[NETWORK_CODE]", "[CREATIVE_TEMPLATE]").toString())
           .build();
   CreativeTemplate response = creativeTemplateServiceClient.getCreativeTemplate(request);
 }

Parameter
Name	Description
`request`	`GetCreativeTemplateRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`CreativeTemplate`

getCreativeTemplate(String name)

public final CreativeTemplate getCreativeTemplate(String name)

API to retrieve a CreativeTemplate 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 (CreativeTemplateServiceClient creativeTemplateServiceClient =
     CreativeTemplateServiceClient.create()) {
   String name = CreativeTemplateName.of("[NETWORK_CODE]", "[CREATIVE_TEMPLATE]").toString();
   CreativeTemplate response = creativeTemplateServiceClient.getCreativeTemplate(name);
 }

Parameter
Name	Description
`name`	`String` Required. The resource name of the CreativeTemplate. Format: `networks/{network_code}/creativeTemplates/{creative_template_id}`

Returns
Type	Description
`CreativeTemplate`

getCreativeTemplateCallable()

public final UnaryCallable<GetCreativeTemplateRequest,CreativeTemplate> getCreativeTemplateCallable()

API to retrieve a CreativeTemplate 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 (CreativeTemplateServiceClient creativeTemplateServiceClient =
     CreativeTemplateServiceClient.create()) {
   GetCreativeTemplateRequest request =
       GetCreativeTemplateRequest.newBuilder()
           .setName(CreativeTemplateName.of("[NETWORK_CODE]", "[CREATIVE_TEMPLATE]").toString())
           .build();
   ApiFuture<CreativeTemplate> future =
       creativeTemplateServiceClient.getCreativeTemplateCallable().futureCall(request);
   // Do something.
   CreativeTemplate response = future.get();
 }

Returns
Type	Description
`UnaryCallable<GetCreativeTemplateRequest,CreativeTemplate>`

getSettings()

public final CreativeTemplateServiceSettings getSettings()

Returns
Type	Description
`CreativeTemplateServiceSettings`

getStub()

public CreativeTemplateServiceStub getStub()

Returns
Type	Description
`CreativeTemplateServiceStub`

isShutdown()

public boolean isShutdown()

Returns
Type	Description
`boolean`

isTerminated()

public boolean isTerminated()

Returns
Type	Description
`boolean`

listCreativeTemplates(ListCreativeTemplatesRequest request)

public final CreativeTemplateServiceClient.ListCreativeTemplatesPagedResponse listCreativeTemplates(ListCreativeTemplatesRequest request)

API to retrieve a list of CreativeTemplate 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 (CreativeTemplateServiceClient creativeTemplateServiceClient =
     CreativeTemplateServiceClient.create()) {
   ListCreativeTemplatesRequest request =
       ListCreativeTemplatesRequest.newBuilder()
           .setParent(NetworkName.of("[NETWORK_CODE]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .setOrderBy("orderBy-1207110587")
           .setSkip(3532159)
           .build();
   for (CreativeTemplate element :
       creativeTemplateServiceClient.listCreativeTemplates(request).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameter
Name	Description
`request`	`ListCreativeTemplatesRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`CreativeTemplateServiceClient.ListCreativeTemplatesPagedResponse`

listCreativeTemplates(NetworkName parent)

public final CreativeTemplateServiceClient.ListCreativeTemplatesPagedResponse listCreativeTemplates(NetworkName parent)

API to retrieve a list of CreativeTemplate 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 (CreativeTemplateServiceClient creativeTemplateServiceClient =
     CreativeTemplateServiceClient.create()) {
   NetworkName parent = NetworkName.of("[NETWORK_CODE]");
   for (CreativeTemplate element :
       creativeTemplateServiceClient.listCreativeTemplates(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameter
Name	Description
`parent`	`NetworkName` Required. The parent, which owns this collection of CreativeTemplates. Format: `networks/{network_code}`

Returns
Type	Description
`CreativeTemplateServiceClient.ListCreativeTemplatesPagedResponse`

listCreativeTemplates(String parent)

public final CreativeTemplateServiceClient.ListCreativeTemplatesPagedResponse listCreativeTemplates(String parent)

API to retrieve a list of CreativeTemplate 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 (CreativeTemplateServiceClient creativeTemplateServiceClient =
     CreativeTemplateServiceClient.create()) {
   String parent = NetworkName.of("[NETWORK_CODE]").toString();
   for (CreativeTemplate element :
       creativeTemplateServiceClient.listCreativeTemplates(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameter
Name	Description
`parent`	`String` Required. The parent, which owns this collection of CreativeTemplates. Format: `networks/{network_code}`

Returns
Type	Description
`CreativeTemplateServiceClient.ListCreativeTemplatesPagedResponse`

listCreativeTemplatesCallable()

public final UnaryCallable<ListCreativeTemplatesRequest,ListCreativeTemplatesResponse> listCreativeTemplatesCallable()

API to retrieve a list of CreativeTemplate 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 (CreativeTemplateServiceClient creativeTemplateServiceClient =
     CreativeTemplateServiceClient.create()) {
   ListCreativeTemplatesRequest request =
       ListCreativeTemplatesRequest.newBuilder()
           .setParent(NetworkName.of("[NETWORK_CODE]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .setOrderBy("orderBy-1207110587")
           .setSkip(3532159)
           .build();
   while (true) {
     ListCreativeTemplatesResponse response =
         creativeTemplateServiceClient.listCreativeTemplatesCallable().call(request);
     for (CreativeTemplate element : response.getCreativeTemplatesList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }

Returns
Type	Description
`UnaryCallable<ListCreativeTemplatesRequest,ListCreativeTemplatesResponse>`

listCreativeTemplatesPagedCallable()

public final UnaryCallable<ListCreativeTemplatesRequest,CreativeTemplateServiceClient.ListCreativeTemplatesPagedResponse> listCreativeTemplatesPagedCallable()

API to retrieve a list of CreativeTemplate 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 (CreativeTemplateServiceClient creativeTemplateServiceClient =
     CreativeTemplateServiceClient.create()) {
   ListCreativeTemplatesRequest request =
       ListCreativeTemplatesRequest.newBuilder()
           .setParent(NetworkName.of("[NETWORK_CODE]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .setOrderBy("orderBy-1207110587")
           .setSkip(3532159)
           .build();
   ApiFuture<CreativeTemplate> future =
       creativeTemplateServiceClient.listCreativeTemplatesPagedCallable().futureCall(request);
   // Do something.
   for (CreativeTemplate element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }

Returns
Type	Description
`UnaryCallable<ListCreativeTemplatesRequest,ListCreativeTemplatesPagedResponse>`

shutdown()

public void shutdown()

shutdownNow()

public void shutdownNow()

Class CreativeTemplateServiceClient (0.39.0) Stay organized with collections Save and categorize content based on your preferences.

Inheritance

Static Methods

create()

create(CreativeTemplateServiceSettings settings)

create(CreativeTemplateServiceStub stub)

Constructors

CreativeTemplateServiceClient(CreativeTemplateServiceSettings settings)

CreativeTemplateServiceClient(CreativeTemplateServiceStub stub)

Methods

awaitTermination(long duration, TimeUnit unit)

close()

getCreativeTemplate(CreativeTemplateName name)

getCreativeTemplate(GetCreativeTemplateRequest request)

getCreativeTemplate(String name)

getCreativeTemplateCallable()

getSettings()

getStub()

isShutdown()

isTerminated()

listCreativeTemplates(ListCreativeTemplatesRequest request)

listCreativeTemplates(NetworkName parent)

listCreativeTemplates(String parent)

listCreativeTemplatesCallable()

listCreativeTemplatesPagedCallable()

shutdown()

shutdownNow()

Class CreativeTemplateServiceClient (0.39.0)