Merchant API code sample to get a notification subscription.
Java
// 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.
package shopping.merchant.samples.notifications.v1;
import com.google.api.gax.core.FixedCredentialsProvider;
import com.google.auth.oauth2.GoogleCredentials;
import com.google.shopping.merchant.notifications.v1.GetNotificationSubscriptionRequest;
import com.google.shopping.merchant.notifications.v1.NotificationSubscription;
import com.google.shopping.merchant.notifications.v1.NotificationSubscriptionName;
import com.google.shopping.merchant.notifications.v1.NotificationsApiServiceClient;
import com.google.shopping.merchant.notifications.v1.NotificationsApiServiceSettings;
import shopping.merchant.samples.utils.Authenticator;
import shopping.merchant.samples.utils.Config;
/**
* This class demonstrates how to get a specific Notification Subscription for a given Merchant
* Center account.
*/
public class GetNotificationSubscriptionSample {
public static void getNotificationSubscription(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.
NotificationsApiServiceSettings notificationsApiServiceSettings =
NotificationsApiServiceSettings.newBuilder()
.setCredentialsProvider(FixedCredentialsProvider.create(credential))
.build();
// Replace "YOUR_NOTIFICATION_SUBSCRIPTION_ID" with the actual ID.
String notificationSubscriptionId = "YOUR_NOTIFICATION_SUBSCRIPTION_ID";
// Creates notification subscription name to identify the subscription.
String name =
NotificationSubscriptionName.newBuilder()
.setAccount(config.getAccountId().toString())
.setNotificationSubscription(notificationSubscriptionId)
.build()
.toString();
// Calls the API and catches and prints any network failures/errors.
try (NotificationsApiServiceClient notificationSubscriptionServiceClient =
NotificationsApiServiceClient.create(notificationsApiServiceSettings)) {
// The name has the format:
// accounts/{account}/notificationSubscription/{notification_subscription}
GetNotificationSubscriptionRequest request =
GetNotificationSubscriptionRequest.newBuilder().setName(name).build();
System.out.println("Sending get Notification Subscription request:");
NotificationSubscription response =
notificationSubscriptionServiceClient.getNotificationSubscription(request);
System.out.println("Retrieved Notification Subscription below:");
System.out.println(response);
} catch (Exception e) {
System.out.println(e);
}
}
public static void main(String[] args) throws Exception {
Config config = Config.load();
getNotificationSubscription(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\Notifications\V1\Client\NotificationsApiServiceClient;
use Google\Shopping\Merchant\Notifications\V1\GetNotificationSubscriptionRequest;
/**
* Gets a Notification Subscription.
*/
class GetNotificationSubscription
{
/**
* Gets a specific Notification Subscription for a given Merchant Center account.
*
* @param array $config
* Configuration data for authentication and account details.
* @param string $notificationSubscriptionId
* The ID of the notification subscription to retrieve.
* @throws ApiException
*/
public static function getNotificationSubscriptionSample($config, $notificationSubscriptionId): void
{
// Get OAuth credentials.
$credentials = Authentication::useServiceAccountOrTokenFile();
// Set up client options.
$options = ['credentials' => $credentials];
// Create a client instance.
$notificationsApiServiceClient = new NotificationsApiServiceClient($options);
// Construct the resource name.
$name = "accounts/" . $config['accountId'] .
"/notificationsubscriptions/" . $notificationSubscriptionId;
// Create the request object.
$request = new GetNotificationSubscriptionRequest(['name' => $name]);
print "Sending get Notification Subscription request:\n";
// Make the API call.
try {
$response = $notificationsApiServiceClient->getNotificationSubscription($request);
print "Retrieved Notification Subscription below:\n";
print_r($response);
} catch (ApiException $e) {
print "Request failed:\n";
print $e->getMessage() . "\n";
}
}
/**
* Execute the sample.
*
* @throws ApiException
*/
public function callSample(): void
{
$config = Config::generateConfig();
// Replace with the actual notification subscription ID.
$notificationSubscriptionId = "YOUR_NOTIFICATION_SUBSCRIPTION_ID";
self::getNotificationSubscriptionSample($config, $notificationSubscriptionId);
}
}
// Run the script.
$sample = new GetNotificationSubscription();
$sample->callSample();
Python
# -*- coding: utf-8 -*-
# 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
#
# 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 NotificationSubscription."""
from examples.authentication import configuration
from examples.authentication import generate_user_credentials
from google.shopping.merchant_notifications_v1 import GetNotificationSubscriptionRequest
from google.shopping.merchant_notifications_v1 import NotificationsApiServiceClient
_ACCOUNT = configuration.Configuration().read_merchant_info()
def get_notification_subscription():
"""Gets a specific Notification Subscription for a given Merchant Center account."""
# Gets OAuth Credentials.
credentials = generate_user_credentials.main()
# Creates a client.
client = NotificationsApiServiceClient(credentials=credentials)
# Replace "YOUR_NOTIFICATION_SUBSCRIPTION_ID" with the actual ID.
notification_subscription_id = "YOUR_NOTIFICATION_SUBSCRIPTION_ID"
# Creates notification subscription name to identify the subscription.
name = f"accounts/{_ACCOUNT}/notificationsubscriptions/{notification_subscription_id}"
# Creates the request.
request = GetNotificationSubscriptionRequest(name=name)
print("Sending get Notification Subscription request:")
# Makes the request and catches and prints any error messages.
try:
response = client.get_notification_subscription(request=request)
print("Retrieved Notification Subscription below:")
print(response)
except RuntimeError as e:
print(e)
if __name__ == "__main__":
get_notification_subscription()