Class ProductsServiceClient (0.11.0)

Service Description: Service to use Product resource. This service works for products with online channel 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 (ProductsServiceClient productsServiceClient = ProductsServiceClient.create()) {
   ProductName name = ProductName.of("[ACCOUNT]", "[PRODUCT]");
   Product response = productsServiceClient.getProduct(name);
 }

Note: close() needs to be called on the ProductsServiceClient 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
GetProduct	Retrieves the processed product from your Merchant Center account. After inserting, updating, or deleting a product input, it may take several minutes before the updated final product can be retrieved.	Request object method variants only take one parameter, a request object, which must be constructed before the call. getProduct(GetProductRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. getProduct(ProductName name) getProduct(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. getProductCallable()
ListProducts	Lists the processed products in your Merchant Center account. The response might contain fewer items than specified by pageSize. Rely on pageToken to determine if there are more items to be requested. After inserting, updating, or deleting a product input, it may take several minutes before the updated processed product can be retrieved.	Request object method variants only take one parameter, a request object, which must be constructed before the call. listProducts(ListProductsRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. listProducts(AccountName parent) listProducts(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. listProductsPagedCallable() listProductsCallable()

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 ProductsServiceSettings 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
 ProductsServiceSettings productsServiceSettings =
     ProductsServiceSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 ProductsServiceClient productsServiceClient =
     ProductsServiceClient.create(productsServiceSettings);

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
 ProductsServiceSettings productsServiceSettings =
     ProductsServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
 ProductsServiceClient productsServiceClient =
     ProductsServiceClient.create(productsServiceSettings);

To use REST (HTTP1.1/JSON) transport (instead of gRPC) for sending and receiving requests over the wire:


 // 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
 ProductsServiceSettings productsServiceSettings =
     ProductsServiceSettings.newHttpJsonBuilder().build();
 ProductsServiceClient productsServiceClient =
     ProductsServiceClient.create(productsServiceSettings);

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

Inheritance

java.lang.Object > ProductsServiceClient

Static Methods

create()

public static final ProductsServiceClient create()

Constructs an instance of ProductsServiceClient with default settings.

Returns
Type	Description
`ProductsServiceClient`

Exceptions
Type	Description
`IOException`

create(ProductsServiceSettings settings)

public static final ProductsServiceClient create(ProductsServiceSettings settings)

Constructs an instance of ProductsServiceClient, 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`	`ProductsServiceSettings`

Returns
Type	Description
`ProductsServiceClient`

Exceptions
Type	Description
`IOException`

create(ProductsServiceStub stub)

public static final ProductsServiceClient create(ProductsServiceStub stub)

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

Parameter
Name	Description
`stub`	`ProductsServiceStub`

Returns
Type	Description
`ProductsServiceClient`

Constructors

ProductsServiceClient(ProductsServiceSettings settings)

protected ProductsServiceClient(ProductsServiceSettings settings)

Constructs an instance of ProductsServiceClient, 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`	`ProductsServiceSettings`

ProductsServiceClient(ProductsServiceStub stub)

protected ProductsServiceClient(ProductsServiceStub stub)

Parameter
Name	Description
`stub`	`ProductsServiceStub`

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

getProduct(GetProductRequest request)

public final Product getProduct(GetProductRequest request)

Retrieves the processed product from your Merchant Center account.

After inserting, updating, or deleting a product input, it may take several minutes before the updated final product can be retrieved.

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 (ProductsServiceClient productsServiceClient = ProductsServiceClient.create()) {
   GetProductRequest request =
       GetProductRequest.newBuilder()
           .setName(ProductName.of("[ACCOUNT]", "[PRODUCT]").toString())
           .build();
   Product response = productsServiceClient.getProduct(request);
 }

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

Returns
Type	Description
`Product`

getProduct(ProductName name)

public final Product getProduct(ProductName name)

Retrieves the processed product from your Merchant Center account.

After inserting, updating, or deleting a product input, it may take several minutes before the updated final product can be retrieved.

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 (ProductsServiceClient productsServiceClient = ProductsServiceClient.create()) {
   ProductName name = ProductName.of("[ACCOUNT]", "[PRODUCT]");
   Product response = productsServiceClient.getProduct(name);
 }

Parameter
Name	Description
`name`	`ProductName` Required. The name of the product to retrieve. Format: `accounts/{account}/products/{product}` where the last section `product` consists of 4 parts: channel~content_language~feed_label~offer_id example for product name is "accounts/123/products/online~en~US~sku123"

Returns
Type	Description
`Product`

getProduct(String name)

public final Product getProduct(String name)

Retrieves the processed product from your Merchant Center account.

After inserting, updating, or deleting a product input, it may take several minutes before the updated final product can be retrieved.

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 (ProductsServiceClient productsServiceClient = ProductsServiceClient.create()) {
   String name = ProductName.of("[ACCOUNT]", "[PRODUCT]").toString();
   Product response = productsServiceClient.getProduct(name);
 }

Parameter
Name	Description
`name`	`String` Required. The name of the product to retrieve. Format: `accounts/{account}/products/{product}` where the last section `product` consists of 4 parts: channel~content_language~feed_label~offer_id example for product name is "accounts/123/products/online~en~US~sku123"

Returns
Type	Description
`Product`

getProductCallable()

public final UnaryCallable<GetProductRequest,Product> getProductCallable()

Retrieves the processed product from your Merchant Center account.

After inserting, updating, or deleting a product input, it may take several minutes before the updated final product can be retrieved.

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 (ProductsServiceClient productsServiceClient = ProductsServiceClient.create()) {
   GetProductRequest request =
       GetProductRequest.newBuilder()
           .setName(ProductName.of("[ACCOUNT]", "[PRODUCT]").toString())
           .build();
   ApiFuture<Product> future = productsServiceClient.getProductCallable().futureCall(request);
   // Do something.
   Product response = future.get();
 }

Returns
Type	Description
`UnaryCallable<GetProductRequest,Product>`

getSettings()

public final ProductsServiceSettings getSettings()

Returns
Type	Description
`ProductsServiceSettings`

getStub()

public ProductsServiceStub getStub()

Returns
Type	Description
`ProductsServiceStub`

isShutdown()

public boolean isShutdown()

Returns
Type	Description
`boolean`

isTerminated()

public boolean isTerminated()

Returns
Type	Description
`boolean`

listProducts(AccountName parent)

public final ProductsServiceClient.ListProductsPagedResponse listProducts(AccountName parent)

Lists the processed products in your Merchant Center account. The response might contain fewer items than specified by pageSize. Rely on pageToken to determine if there are more items to be requested.

After inserting, updating, or deleting a product input, it may take several minutes before the updated processed product can be retrieved.

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 (ProductsServiceClient productsServiceClient = ProductsServiceClient.create()) {
   AccountName parent = AccountName.of("[ACCOUNT]");
   for (Product element : productsServiceClient.listProducts(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameter
Name	Description
`parent`	`AccountName` Required. The account to list processed products for. Format: accounts/{account}

Returns
Type	Description
`ProductsServiceClient.ListProductsPagedResponse`

listProducts(ListProductsRequest request)

public final ProductsServiceClient.ListProductsPagedResponse listProducts(ListProductsRequest request)

After inserting, updating, or deleting a product input, it may take several minutes before the updated processed product can be retrieved.

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 (ProductsServiceClient productsServiceClient = ProductsServiceClient.create()) {
   ListProductsRequest request =
       ListProductsRequest.newBuilder()
           .setParent(AccountName.of("[ACCOUNT]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   for (Product element : productsServiceClient.listProducts(request).iterateAll()) {
     // doThingsWith(element);
   }
 }

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

Returns
Type	Description
`ProductsServiceClient.ListProductsPagedResponse`

listProducts(String parent)

public final ProductsServiceClient.ListProductsPagedResponse listProducts(String parent)

After inserting, updating, or deleting a product input, it may take several minutes before the updated processed product can be retrieved.

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 (ProductsServiceClient productsServiceClient = ProductsServiceClient.create()) {
   String parent = AccountName.of("[ACCOUNT]").toString();
   for (Product element : productsServiceClient.listProducts(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameter
Name	Description
`parent`	`String` Required. The account to list processed products for. Format: accounts/{account}

Returns
Type	Description
`ProductsServiceClient.ListProductsPagedResponse`

listProductsCallable()

public final UnaryCallable<ListProductsRequest,ListProductsResponse> listProductsCallable()

After inserting, updating, or deleting a product input, it may take several minutes before the updated processed product can be retrieved.

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 (ProductsServiceClient productsServiceClient = ProductsServiceClient.create()) {
   ListProductsRequest request =
       ListProductsRequest.newBuilder()
           .setParent(AccountName.of("[ACCOUNT]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   while (true) {
     ListProductsResponse response = productsServiceClient.listProductsCallable().call(request);
     for (Product element : response.getProductsList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }

Returns
Type	Description
`UnaryCallable<ListProductsRequest,ListProductsResponse>`

listProductsPagedCallable()

public final UnaryCallable<ListProductsRequest,ProductsServiceClient.ListProductsPagedResponse> listProductsPagedCallable()

After inserting, updating, or deleting a product input, it may take several minutes before the updated processed product can be retrieved.

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 (ProductsServiceClient productsServiceClient = ProductsServiceClient.create()) {
   ListProductsRequest request =
       ListProductsRequest.newBuilder()
           .setParent(AccountName.of("[ACCOUNT]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   ApiFuture<Product> future =
       productsServiceClient.listProductsPagedCallable().futureCall(request);
   // Do something.
   for (Product element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }

Returns
Type	Description
`UnaryCallable<ListProductsRequest,ListProductsPagedResponse>`

shutdown()

public void shutdown()

shutdownNow()

public void shutdownNow()