Merchant API code sample to get a program.
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.programs.v1beta;
import com.google.api.gax.core.FixedCredentialsProvider;
import com.google.auth.oauth2.GoogleCredentials;
import com.google.shopping.merchant.accounts.v1beta.GetProgramRequest;
import com.google.shopping.merchant.accounts.v1beta.Program;
import com.google.shopping.merchant.accounts.v1beta.ProgramName;
import com.google.shopping.merchant.accounts.v1beta.ProgramsServiceClient;
import com.google.shopping.merchant.accounts.v1beta.ProgramsServiceSettings;
import shopping.merchant.samples.utils.Authenticator;
import shopping.merchant.samples.utils.Config;
/**
* This class demonstrates how to get a single shopping program resource for a Merchant Center
* account.
*/
public class GetProgramSample {
public static void getProgram(Config config, String program) throws Exception {
// Obtains OAuth token based on the user's configuration.
GoogleCredentials credential = new Authenticator().authenticate();
// Creates service settings using the credentials retrieved above.
ProgramsServiceSettings programsServiceSettings =
ProgramsServiceSettings.newBuilder()
.setCredentialsProvider(FixedCredentialsProvider.create(credential))
.build();
// Creates program name to identify the program.
String name =
ProgramName.newBuilder()
.setAccount(config.getAccountId().toString())
.setProgram(program)
.build()
.toString();
// Calls the API and catches and prints any network failures/errors.
try (ProgramsServiceClient programsServiceClient =
ProgramsServiceClient.create(programsServiceSettings)) {
// The name has the format: accounts/{account}/programs/{program}
GetProgramRequest request = GetProgramRequest.newBuilder().setName(name).build();
System.out.println("Sending Get Program request:");
Program response = programsServiceClient.getProgram(request);
System.out.println("Retrieved Program below");
System.out.println(response);
} catch (Exception e) {
System.out.println(e);
}
}
public static void main(String[] args) throws Exception {
Config config = Config.load();
// Replace this with the name of the program to retrieve.
String program = "free-listings";
getProgram(config, program);
}
}
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\V1beta\Client\ProgramsServiceClient;
use Google\Shopping\Merchant\Accounts\V1beta\GetProgramRequest;
/**
* This class demonstrates how to get a single shopping program resource for a Merchant Center
* account.
*/
class GetProgramSample
{
/**
* Retrieves a program for the given Merchant Center account.
*
* @param array $config The configuration data for authentication and account ID.
* @param string $program The program to retrieve.
* @return void
*/
public static function getProgram($config, $program): 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.
$programsServiceClient = new ProgramsServiceClient($options);
// Creates program name to identify the program.
$name = $parent = "accounts/" . $config['accountId'] . "/programs/" . $program;
// Calls the API and catches and prints any network failures/errors.
try {
// The name has the format: accounts/{account}/programs/{program}
$request = new GetProgramRequest(['name' => $name]);
print "Sending Get Program request:\n";
$response = $programsServiceClient->getProgram($request);
print "Retrieved Program 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();
// Replace this with the name of the program to retrieve.
$program = "free-listings";
self::getProgram($config, $program);
}
}
// Run the script
$sample = new GetProgramSample();
$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 for getting a program resource for a Merchant Center account."""
from examples.authentication import configuration
from examples.authentication import generate_user_credentials
from google.shopping.merchant_accounts_v1beta import GetProgramRequest
from google.shopping.merchant_accounts_v1beta import ProgramsServiceClient
_ACCOUNT = configuration.Configuration().read_merchant_info()
def get_program(program_):
"""Gets a program resource for a Merchant Center account."""
# Gets OAuth Credentials.
credentials = generate_user_credentials.main()
# Creates a client.
client = ProgramsServiceClient(credentials=credentials)
# Creates program name to identify the program.
name = "accounts/" + _ACCOUNT + "/programs/" + program_
# Creates the request.
request = GetProgramRequest(name=name)
# Makes the request and catches and prints any error messages.
try:
print("Sending Get Program request:")
response = client.get_program(request=request)
print("Retrieved Program below")
print(response)
except RuntimeError as e:
print(e)
if __name__ == "__main__":
program = "free-listings"
get_program(program)