Merchant API code sample to get a product.
AppsScript
//
Copyright
2025
Google
LLC
//
//
Licensed
under
the
Apache
License
,
Version
2.0
(
the
"License"
);
//
you
may
not
use
this
file
except
in
compliance
with
the
License
.
//
You
may
obtain
a
copy
of
the
License
at
//
//
https
:
//
www
.
apache
.
org
/
licenses
/
LICENSE
-
2.0
//
//
Unless
required
by
applicable
law
or
agreed
to
in
writing
,
software
//
distributed
under
the
License
is
distributed
on
an
"AS IS"
BASIS
,
//
WITHOUT
WARRANTIES
OR
CONDITIONS
OF
ANY
KIND
,
either
express
or
implied
.
//
See
the
License
for
the
specific
language
governing
permissions
and
//
limitations
under
the
License
.
/**
*
Get
a
specific
product
for
a
given
Merchant
Center
account
.
*/
function
getProduct
()
{
//
IMPORTANT
:
//
Enable
the
Merchant
API
Products
sub
-
API
Advanced
Service
and
call
it
//
"MerchantApiProducts"
//
Replace
this
with
your
Merchant
Center
ID
.
const
accountId
=
'<MERCHANT_CENTER_ID>'
;
//
The
ID
of
the
product
to
retrieve
.
//
This
ID
is
assigned
by
Google
and
typically
follows
the
format
:
//
channel
~
contentLanguage
~
feedLabel
~
offerId
//
Replace
with
an
actual
product
ID
from
your
Merchant
Center
account
.
const
productId
=
'<PRODUCT_ID>'
;
//
Construct
the
parent
name
const
parent
=
'accounts/'
+
accountId
;
//
Construct
the
product
resource
name
const
name
=
parent
+
"/products/"
+
productId
;
try
{
console
.
log
(
'Sending get Product request'
);
//
Call
the
Products
.
get
API
method
.
product
=
MerchantApiProducts
.
Accounts
.
Products
.
get
(
name
);
console
.
log
(
product
);
}
catch
(
e
)
{
console
.
log
(
'ERROR!'
);
console
.
log
(
e
);
}
}
Java
// Copyright 2024 Google LLC
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// https://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
package
shopping.merchant.samples.products.v1
;
import
com.google.api.gax.core.FixedCredentialsProvider
;
import
com.google.auth.oauth2.GoogleCredentials
;
import
com.google.shopping.merchant.products.v1.GetProductRequest
;
import
com.google.shopping.merchant.products.v1.Product
;
import
com.google.shopping.merchant.products.v1.ProductsServiceClient
;
import
com.google.shopping.merchant.products.v1.ProductsServiceSettings
;
import
shopping.merchant.samples.utils.Authenticator
;
import
shopping.merchant.samples.utils.Config
;
/** This class demonstrates how to get a single product for a given Merchant Center account */
public
class
GetProductSample
{
public
static
void
getProduct
(
Config
config
,
String
product
)
throws
Exception
{
// Obtains OAuth token based on the user's configuration.
GoogleCredentials
credential
=
new
Authenticator
().
authenticate
();
// Creates service settings using the credentials retrieved above.
ProductsServiceSettings
productsServiceSettings
=
ProductsServiceSettings
.
newBuilder
()
.
setCredentialsProvider
(
FixedCredentialsProvider
.
create
(
credential
))
.
build
();
// Calls the API and catches and prints any network failures/errors.
try
(
ProductsServiceClient
productsServiceClient
=
ProductsServiceClient
.
create
(
productsServiceSettings
))
{
// The name has the format: accounts/{account}/products/{productId}
GetProductRequest
request
=
GetProductRequest
.
newBuilder
().
setName
(
product
).
build
();
System
.
out
.
println
(
"Sending get product request:"
);
Product
response
=
productsServiceClient
.
getProduct
(
request
);
System
.
out
.
println
(
"Retrieved Product below"
);
System
.
out
.
println
(
response
);
}
catch
(
Exception
e
)
{
System
.
out
.
println
(
e
);
}
}
public
static
void
main
(
String
[]
args
)
throws
Exception
{
Config
config
=
Config
.
load
();
// The name of the `product`, returned after a `Product.insert` request. We recommend
// having stored this value in your database to use for all future requests.
String
product
=
"accounts/{datasource}/products/{productId}"
;
getProduct
(
config
,
product
);
}
}
Node.js
// Copyright 2025 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// https://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
'use strict'
;
const
fs
=
require
(
'fs'
);
const
authUtils
=
require
(
'../../authentication/authenticate.js'
);
const
{
ProductsServiceClient
}
=
require
(
'@google-shopping/products'
).
v1
;
/**
* Retrieves a single product for a given Merchant Center account.
* @param {!object} config - The configuration object.
* @param {string} productName - The name of the product to retrieve.
*/
async
function
getProduct
(
config
,
productName
)
{
// Get credentials.
const
authClient
=
await
authUtils
.
getOrGenerateUserCredentials
();
// Create options object for the client.
const
options
=
{
authClient
:
authClient
};
// Create the ProductsServiceClient.
const
productsClient
=
new
ProductsServiceClient
(
options
);
// Construct the request object.
const
request
=
{
name
:
productName
,
};
try
{
console
.
log
(
'Sending get product request:'
);
// Call the API to get the product.
const
response
=
await
productsClient
.
getProduct
(
request
);
console
.
log
(
'Retrieved Product below'
);
console
.
log
(
response
);
}
catch
(
error
)
{
console
.
error
(
error
.
message
);
}
}
/**
* Main function to call the getProduct sample.
*/
async
function
main
()
{
const
config
=
authUtils
.
getConfig
();
// Read merchant_id from merchant-info.json.
const
merchantInfo
=
JSON
.
parse
(
fs
.
readFileSync
(
config
.
merchantInfoFile
,
'utf8'
));
const
merchantId
=
merchantInfo
.
merchantId
;
// The name of the `product`. Replace {product} with the actual ID.
// Format: accounts/{account}/products/{product}
// {product} is usually in the format:
// contentLanguage~feedLabel~offerId
const
productName
=
`accounts/
${
merchantId
}
/products/{productId}`
;
await
getProduct
(
config
,
productName
);
}
main
();
PHP
< ?php
/**
* Copyright 2024 Google LLC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
require_once __DIR__ . '/../../../vendor/autoload.php';
require_once __DIR__ . '/../../Authentication/Authentication.php';
require_once __DIR__ . '/../../Authentication/Config.php';
use Google\ApiCore\ApiException;
use Google\Shopping\Merchant\Products\V1\GetProductRequest;
use Google\Shopping\Merchant\Products\V1\Product;
use Google\Shopping\Merchant\Products\V1\Client\ProductsServiceClient;
/**
* This class demonstrates how to get a single product for a given Merchant Center
* account.
*/
class GetProduct
{
// ENSURE you fill in the product ID for the sample to work.
private const PRODUCT = 'INSERT_PRODUCT_ID_HERE';
/**
* Gets a product from your Merchant Center account.
*
* @param array $config
* The configuration data used for authentication and getting the acccount
* ID.
* @param string $product
* The product ID to get.
* Format: `accounts/{account}/products/{productId}`.
*
* @return void
*/
public static function getProductSample($config, $product) : void
{
// Gets the OAuth credentials to make the request.
$credentials = Authentication::useServiceAccountOrTokenFile();
// Creates options config containing credentials for the client to use.
$options = ['credentials' => $credentials];
// Creates a client.
$productsServiceClient = new ProductsServiceClient($options);
try {
// Creates the request.
$request = new GetProductRequest(
[
'name' => $product
]
);
// Sends the request.
echo "Sending get Product request\n";
$response = $productsServiceClient->getProduct($request);
// Outputs the response.
echo "Retrieved Product below\n";
print_r($response);
} catch (Exception $e) {
echo $e->getMessage();
}
}
/**
* Helper to execute the sample.
*
* @return void
*/
public function callSample(): void
{
$config = Config::generateConfig();
// Identifies the product to retrieve.
// The name has the format: accounts/{account}/products/{productId}.
$product = ProductsServiceClient::productName(
$config['accountId'],
self::PRODUCT
);
self::getProductSample($config, $product);
}
}
$sample = new GetProduct();
$sample->callSample();
