Class ProgrammaticBuyerServiceClient (0.27.0)

Service Description: Provides methods for handling ProgrammaticBuyer 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 (ProgrammaticBuyerServiceClient programmaticBuyerServiceClient =
     ProgrammaticBuyerServiceClient.create()) {
   ProgrammaticBuyerName name =
       ProgrammaticBuyerName.of("[NETWORK_CODE]", "[PROGRAMMATIC_BUYER]");
   ProgrammaticBuyer response = programmaticBuyerServiceClient.getProgrammaticBuyer(name);
 }

Note: close() needs to be called on the ProgrammaticBuyerServiceClient 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
GetProgrammaticBuyer	API to retrieve a `ProgrammaticBuyer` object.	Request object method variants only take one parameter, a request object, which must be constructed before the call. getProgrammaticBuyer(GetProgrammaticBuyerRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. getProgrammaticBuyer(ProgrammaticBuyerName name) getProgrammaticBuyer(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. getProgrammaticBuyerCallable()
ListProgrammaticBuyers	API to retrieve a list of `ProgrammaticBuyer` objects.	Request object method variants only take one parameter, a request object, which must be constructed before the call. listProgrammaticBuyers(ListProgrammaticBuyersRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. listProgrammaticBuyers(NetworkName parent) listProgrammaticBuyers(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. listProgrammaticBuyersPagedCallable() listProgrammaticBuyersCallable()

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 ProgrammaticBuyerServiceSettings 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
 ProgrammaticBuyerServiceSettings programmaticBuyerServiceSettings =
     ProgrammaticBuyerServiceSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 ProgrammaticBuyerServiceClient programmaticBuyerServiceClient =
     ProgrammaticBuyerServiceClient.create(programmaticBuyerServiceSettings);

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
 ProgrammaticBuyerServiceSettings programmaticBuyerServiceSettings =
     ProgrammaticBuyerServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
 ProgrammaticBuyerServiceClient programmaticBuyerServiceClient =
     ProgrammaticBuyerServiceClient.create(programmaticBuyerServiceSettings);

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

Inheritance

java.lang.Object > ProgrammaticBuyerServiceClient

Static Methods

create()

public static final ProgrammaticBuyerServiceClient create()

Constructs an instance of ProgrammaticBuyerServiceClient with default settings.

Returns
Type	Description
`ProgrammaticBuyerServiceClient`

Exceptions
Type	Description
`IOException`

create(ProgrammaticBuyerServiceSettings settings)

public static final ProgrammaticBuyerServiceClient create(ProgrammaticBuyerServiceSettings settings)

Constructs an instance of ProgrammaticBuyerServiceClient, 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`	`ProgrammaticBuyerServiceSettings`

Returns
Type	Description
`ProgrammaticBuyerServiceClient`

Exceptions
Type	Description
`IOException`

create(ProgrammaticBuyerServiceStub stub)

public static final ProgrammaticBuyerServiceClient create(ProgrammaticBuyerServiceStub stub)

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

Parameter
Name	Description
`stub`	`ProgrammaticBuyerServiceStub`

Returns
Type	Description
`ProgrammaticBuyerServiceClient`

Constructors

ProgrammaticBuyerServiceClient(ProgrammaticBuyerServiceSettings settings)

protected ProgrammaticBuyerServiceClient(ProgrammaticBuyerServiceSettings settings)

Constructs an instance of ProgrammaticBuyerServiceClient, 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`	`ProgrammaticBuyerServiceSettings`

ProgrammaticBuyerServiceClient(ProgrammaticBuyerServiceStub stub)

protected ProgrammaticBuyerServiceClient(ProgrammaticBuyerServiceStub stub)

Parameter
Name	Description
`stub`	`ProgrammaticBuyerServiceStub`

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()

getProgrammaticBuyer(GetProgrammaticBuyerRequest request)

public final ProgrammaticBuyer getProgrammaticBuyer(GetProgrammaticBuyerRequest request)

API to retrieve a ProgrammaticBuyer 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 (ProgrammaticBuyerServiceClient programmaticBuyerServiceClient =
     ProgrammaticBuyerServiceClient.create()) {
   GetProgrammaticBuyerRequest request =
       GetProgrammaticBuyerRequest.newBuilder()
           .setName(
               ProgrammaticBuyerName.of("[NETWORK_CODE]", "[PROGRAMMATIC_BUYER]").toString())
           .build();
   ProgrammaticBuyer response = programmaticBuyerServiceClient.getProgrammaticBuyer(request);
 }

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

Returns
Type	Description
`ProgrammaticBuyer`

getProgrammaticBuyer(ProgrammaticBuyerName name)

public final ProgrammaticBuyer getProgrammaticBuyer(ProgrammaticBuyerName name)

API to retrieve a ProgrammaticBuyer 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 (ProgrammaticBuyerServiceClient programmaticBuyerServiceClient =
     ProgrammaticBuyerServiceClient.create()) {
   ProgrammaticBuyerName name =
       ProgrammaticBuyerName.of("[NETWORK_CODE]", "[PROGRAMMATIC_BUYER]");
   ProgrammaticBuyer response = programmaticBuyerServiceClient.getProgrammaticBuyer(name);
 }

Parameter
Name	Description
`name`	`ProgrammaticBuyerName` Required. The resource name of the ProgrammaticBuyer. Format: `networks/{network_code}/programmaticBuyers/{buyer_account_id}`

Returns
Type	Description
`ProgrammaticBuyer`

getProgrammaticBuyer(String name)

public final ProgrammaticBuyer getProgrammaticBuyer(String name)

API to retrieve a ProgrammaticBuyer 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 (ProgrammaticBuyerServiceClient programmaticBuyerServiceClient =
     ProgrammaticBuyerServiceClient.create()) {
   String name = ProgrammaticBuyerName.of("[NETWORK_CODE]", "[PROGRAMMATIC_BUYER]").toString();
   ProgrammaticBuyer response = programmaticBuyerServiceClient.getProgrammaticBuyer(name);
 }

Parameter
Name	Description
`name`	`String` Required. The resource name of the ProgrammaticBuyer. Format: `networks/{network_code}/programmaticBuyers/{buyer_account_id}`

Returns
Type	Description
`ProgrammaticBuyer`

getProgrammaticBuyerCallable()

public final UnaryCallable<GetProgrammaticBuyerRequest,ProgrammaticBuyer> getProgrammaticBuyerCallable()

API to retrieve a ProgrammaticBuyer 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 (ProgrammaticBuyerServiceClient programmaticBuyerServiceClient =
     ProgrammaticBuyerServiceClient.create()) {
   GetProgrammaticBuyerRequest request =
       GetProgrammaticBuyerRequest.newBuilder()
           .setName(
               ProgrammaticBuyerName.of("[NETWORK_CODE]", "[PROGRAMMATIC_BUYER]").toString())
           .build();
   ApiFuture<ProgrammaticBuyer> future =
       programmaticBuyerServiceClient.getProgrammaticBuyerCallable().futureCall(request);
   // Do something.
   ProgrammaticBuyer response = future.get();
 }

Returns
Type	Description
`UnaryCallable<GetProgrammaticBuyerRequest,ProgrammaticBuyer>`

getSettings()

public final ProgrammaticBuyerServiceSettings getSettings()

Returns
Type	Description
`ProgrammaticBuyerServiceSettings`

getStub()

public ProgrammaticBuyerServiceStub getStub()

Returns
Type	Description
`ProgrammaticBuyerServiceStub`

isShutdown()

public boolean isShutdown()

Returns
Type	Description
`boolean`

isTerminated()

public boolean isTerminated()

Returns
Type	Description
`boolean`

listProgrammaticBuyers(ListProgrammaticBuyersRequest request)

public final ProgrammaticBuyerServiceClient.ListProgrammaticBuyersPagedResponse listProgrammaticBuyers(ListProgrammaticBuyersRequest request)

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

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

Returns
Type	Description
`ProgrammaticBuyerServiceClient.ListProgrammaticBuyersPagedResponse`

listProgrammaticBuyers(NetworkName parent)

public final ProgrammaticBuyerServiceClient.ListProgrammaticBuyersPagedResponse listProgrammaticBuyers(NetworkName parent)

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

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

Returns
Type	Description
`ProgrammaticBuyerServiceClient.ListProgrammaticBuyersPagedResponse`

listProgrammaticBuyers(String parent)

public final ProgrammaticBuyerServiceClient.ListProgrammaticBuyersPagedResponse listProgrammaticBuyers(String parent)

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

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

Returns
Type	Description
`ProgrammaticBuyerServiceClient.ListProgrammaticBuyersPagedResponse`

listProgrammaticBuyersCallable()

public final UnaryCallable<ListProgrammaticBuyersRequest,ListProgrammaticBuyersResponse> listProgrammaticBuyersCallable()

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

Returns
Type	Description
`UnaryCallable<ListProgrammaticBuyersRequest,ListProgrammaticBuyersResponse>`

listProgrammaticBuyersPagedCallable()

public final UnaryCallable<ListProgrammaticBuyersRequest,ProgrammaticBuyerServiceClient.ListProgrammaticBuyersPagedResponse> listProgrammaticBuyersPagedCallable()

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

Returns
Type	Description
`UnaryCallable<ListProgrammaticBuyersRequest,ListProgrammaticBuyersPagedResponse>`

shutdown()

public void shutdown()

shutdownNow()

public void shutdownNow()

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

Inheritance

Static Methods

create()

create(ProgrammaticBuyerServiceSettings settings)

create(ProgrammaticBuyerServiceStub stub)

Constructors

ProgrammaticBuyerServiceClient(ProgrammaticBuyerServiceSettings settings)

ProgrammaticBuyerServiceClient(ProgrammaticBuyerServiceStub stub)

Methods

awaitTermination(long duration, TimeUnit unit)

close()

getProgrammaticBuyer(GetProgrammaticBuyerRequest request)

getProgrammaticBuyer(ProgrammaticBuyerName name)

getProgrammaticBuyer(String name)

getProgrammaticBuyerCallable()

getSettings()

getStub()

isShutdown()

isTerminated()

listProgrammaticBuyers(ListProgrammaticBuyersRequest request)

listProgrammaticBuyers(NetworkName parent)

listProgrammaticBuyers(String parent)

listProgrammaticBuyersCallable()

listProgrammaticBuyersPagedCallable()

shutdown()

shutdownNow()

Class ProgrammaticBuyerServiceClient (0.27.0)