Page Summary
-
This code sample demonstrates how to disable a shopping program within a Merchant Center account using the Merchant API.
-
The provided Java code uses the
ProgramsServiceClientto send aDisableProgramRequestto the Merchant API. -
The code requires authentication via OAuth 2.0, which is handled by the
Authenticatorutility class. -
The program to be disabled is specified by its name, which has the format:
accounts/{account}/programs/{program}. -
The code includes error handling to catch and print any network issues or API errors during the process.
Merchant API code sample to disable 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.v1
;
import
com.google.api.gax.core.FixedCredentialsProvider
;
import
com.google.auth.oauth2.GoogleCredentials
;
import
com.google.shopping.merchant.accounts.v1.DisableProgramRequest
;
import
com.google.shopping.merchant.accounts.v1.Program
;
import
com.google.shopping.merchant.accounts.v1.ProgramName
;
import
com.google.shopping.merchant.accounts.v1.ProgramsServiceClient
;
import
com.google.shopping.merchant.accounts.v1.ProgramsServiceSettings
;
import
shopping.merchant.samples.utils.Authenticator
;
import
shopping.merchant.samples.utils.Config
;
/** This class demonstrates how to disable a shopping program for a Merchant Center account. */
public
class
DisableProgramSample
{
public
static
void
disableProgram
(
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}
DisableProgramRequest
request
=
DisableProgramRequest
.
newBuilder
().
setName
(
name
).
build
();
System
.
out
.
println
(
"Sending Disable Program request:"
);
Program
response
=
programsServiceClient
.
disableProgram
(
request
);
System
.
out
.
println
(
"Disabled 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 be disabled.
String
program
=
"free-listings"
;
disableProgram
(
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\V1\Client\ProgramsServiceClient;
use Google\Shopping\Merchant\Accounts\V1\DisableProgramRequest;
/**
* This class demonstrates how to disable a shopping program for a Merchant Center account.
*/
class DisableProgramSample
{
/**
* Disables 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 disable.
* @return void
*/
public static function disableProgram($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 DisableProgramRequest(['name' => $name]);
print "Sending Disable Program request:\n";
$response = $programsServiceClient->disableProgram($request);
print "Disabled 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 be disabled.
$program = "free-listings";
self::disableProgram($config, $program);
}
}
// Run the script
$sample = new DisableProgramSample();
$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 for disabling a program for a Merchant Center account."""
from
examples.authentication
import
configuration
from
examples.authentication
import
generate_user_credentials
from
google.shopping.merchant_accounts_v1
import
DisableProgramRequest
from
google.shopping.merchant_accounts_v1
import
ProgramsServiceClient
_ACCOUNT
=
configuration
.
Configuration
()
.
read_merchant_info
()
def
disable_program
(
program
):
"""Disables a program for the given 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
=
DisableProgramRequest
(
name
=
name
)
# Makes the request and catches and prints any error messages.
try
:
response
=
client
.
disable_program
(
request
=
request
)
print
(
"Disabled Program below"
)
print
(
response
)
return
response
except
RuntimeError
as
e
:
print
(
e
)
return
None
if
__name__
==
"__main__"
:
# Replace this with the name of the program to be disabled.
program_to_disable
=
"free-listings"
disable_program
(
program_to_disable
)
