Page Summary
-
This page provides Java and Python code samples demonstrating how to retrieve the homepage for a specified Merchant Center account.
-
The Java code sample utilizes the
HomepageServiceClientto send aGetHomepageRequestwith a specific account ID to obtain the homepage. -
The Python code sample demonstrates a similar process, using the
HomepageServiceClientandGetHomepageRequestobjects to fetch homepage information. -
Both code samples include error handling to catch and print any exceptions that may occur during the API call.
-
The provided links allow you to see the full code on the Merchant API samples GitHub.
Merchant API code sample to get an homepage.
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.accounts.homepages.v1
;
import
com.google.api.gax.core.FixedCredentialsProvider
;
import
com.google.auth.oauth2.GoogleCredentials
;
import
com.google.shopping.merchant.accounts.v1.GetHomepageRequest
;
import
com.google.shopping.merchant.accounts.v1.Homepage
;
import
com.google.shopping.merchant.accounts.v1.HomepageName
;
import
com.google.shopping.merchant.accounts.v1.HomepageServiceClient
;
import
com.google.shopping.merchant.accounts.v1.HomepageServiceSettings
;
import
shopping.merchant.samples.utils.Authenticator
;
import
shopping.merchant.samples.utils.Config
;
/** This class demonstrates how to get the homepage for a given Merchant Center account */
public
class
GetHomepageSample
{
public
static
void
getHomepage
(
Config
config
)
throws
Exception
{
// Obtains OAuth token based on the user's configuration.
GoogleCredentials
credential
=
new
Authenticator
().
authenticate
();
// Creates service settings using the credentials retrieved above.
HomepageServiceSettings
homepageServiceSettings
=
HomepageServiceSettings
.
newBuilder
()
.
setCredentialsProvider
(
FixedCredentialsProvider
.
create
(
credential
))
.
build
();
// Creates Homepage name to identify Homepage.
String
name
=
HomepageName
.
newBuilder
().
setAccount
(
config
.
getAccountId
().
toString
()).
build
().
toString
();
// Calls the API and catches and prints any network failures/errors.
try
(
HomepageServiceClient
homepageServiceClient
=
HomepageServiceClient
.
create
(
homepageServiceSettings
))
{
// The name has the format: accounts/{account}/homepage
GetHomepageRequest
request
=
GetHomepageRequest
.
newBuilder
().
setName
(
name
).
build
();
System
.
out
.
println
(
"Sending Get Homepage request:"
);
Homepage
response
=
homepageServiceClient
.
getHomepage
(
request
);
System
.
out
.
println
(
"Retrieved Homepage below"
);
System
.
out
.
println
(
response
);
}
catch
(
Exception
e
)
{
System
.
out
.
println
(
e
);
}
}
public
static
void
main
(
String
[]
args
)
throws
Exception
{
Config
config
=
Config
.
load
();
getHomepage
(
config
);
}
}
PHP
< ?php
/**
* 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.
*/
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\Accounts\V1\GetHomepageRequest;
use Google\Shopping\Merchant\Accounts\V1\Client\HomepageServiceClient;
/**
* This class demonstrates how to get the homepage for a given Merchant Center account
*/
class GetHomepage
{
/**
* Gets the homepage for a given Merchant Center account.
*
* @param array $config The configuration data for authentication and account ID.
* @return void
* @throws ApiException if the API call fails.
*/
public static function getHomepageSample(array $config): 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.
$homepageServiceClient = new HomepageServiceClient($options);
// Creates Homepage name to identify Homepage.
// The name has the format: accounts/{account}/homepage
$name = "accounts/" . $config['accountId'] . "/homepage";
// Calls the API and catches and prints any network failures/errors.
try {
$request = new GetHomepageRequest(['name' => $name]);
print "Sending Get Homepage request:\n";
$response = $homepageServiceClient->getHomepage($request);
print "Retrieved Homepage below\n";
print_r($response);
} catch (ApiException $e) {
print $e->getMessage();
}
}
/**
* Helper to execute the sample.
*
* @return void
*/
public function callSample(): void
{
$config = Config::generateConfig();
// Makes the call to get the homepage.
self::getHomepageSample($config);
}
}
// Run the script
$sample = new GetHomepage();
$sample->callSample();
Python
# -*- coding: utf-8 -*-
# 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
#
# http://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.
"""A module to get a Homepage."""
from
examples.authentication
import
configuration
from
examples.authentication
import
generate_user_credentials
from
google.shopping.merchant_accounts_v1
import
GetHomepageRequest
from
google.shopping.merchant_accounts_v1
import
HomepageServiceClient
_ACCOUNT
=
configuration
.
Configuration
()
.
read_merchant_info
()
def
get_homepage
():
"""Gets the homepage for a given Merchant Center account."""
# Gets OAuth Credentials.
credentials
=
generate_user_credentials
.
main
()
# Creates a client.
client
=
HomepageServiceClient
(
credentials
=
credentials
)
# Creates Homepage name to identify Homepage.
name
=
"accounts/"
+
_ACCOUNT
+
"/homepage"
# Creates the request.
request
=
GetHomepageRequest
(
name
=
name
)
# Makes the request and catches and prints any error messages.
try
:
response
=
client
.
get_homepage
(
request
=
request
)
print
(
"Retrieved Homepage below"
)
print
(
response
)
except
RuntimeError
as
e
:
print
(
e
)
if
__name__
==
"__main__"
:
get_homepage
()
