Merchant API code sample to propose an account service.
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.accountservices.v1
;
import
com.google.api.gax.core.FixedCredentialsProvider
;
import
com.google.auth.oauth2.GoogleCredentials
;
import
com.google.shopping.merchant.accounts.v1.AccountAggregation
;
import
com.google.shopping.merchant.accounts.v1.AccountService
;
import
com.google.shopping.merchant.accounts.v1.AccountServicesServiceClient
;
import
com.google.shopping.merchant.accounts.v1.AccountServicesServiceSettings
;
import
com.google.shopping.merchant.accounts.v1.ProposeAccountServiceRequest
;
import
java.math.BigInteger
;
import
shopping.merchant.samples.utils.Authenticator
;
import
shopping.merchant.samples.utils.Config
;
/** This class demonstrates how to propose an account service. */
public
class
ProposeAccountServiceSample
{
private
static
String
toAccountName
(
BigInteger
accountId
)
{
return
String
.
format
(
"accounts/%d"
,
accountId
);
}
public
static
void
proposeAccountService
(
Config
config
,
BigInteger
providerId
)
throws
Exception
{
GoogleCredentials
credential
=
new
Authenticator
().
authenticate
();
AccountServicesServiceSettings
accountServiceServiceSettings
=
AccountServicesServiceSettings
.
newBuilder
()
.
setCredentialsProvider
(
FixedCredentialsProvider
.
create
(
credential
))
.
build
();
try
(
AccountServicesServiceClient
accountServiceServiceClient
=
AccountServicesServiceClient
.
create
(
accountServiceServiceSettings
))
{
ProposeAccountServiceRequest
request
=
ProposeAccountServiceRequest
.
newBuilder
()
.
setParent
(
toAccountName
(
config
.
getAccountId
()))
.
setProvider
(
toAccountName
(
providerId
))
.
setAccountService
(
AccountService
.
newBuilder
()
.
setAccountAggregation
(
AccountAggregation
.
getDefaultInstance
())
.
build
())
.
build
();
System
.
out
.
println
(
"Sending Propose AccountService request"
);
AccountService
response
=
accountServiceServiceClient
.
proposeAccountService
(
request
);
System
.
out
.
println
(
"Proposed AccountService below"
);
System
.
out
.
println
(
response
);
}
catch
(
Exception
e
)
{
System
.
out
.
println
(
e
);
}
}
public
static
void
main
(
String
[]
args
)
throws
Exception
{
Config
config
=
Config
.
load
();
// Update this with the Merchant Center provider ID you want to get the relationship for.
BigInteger
providerId
=
BigInteger
.
valueOf
(
111
);
proposeAccountService
(
config
,
providerId
);
}
}
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\AccountAggregation;
use Google\Shopping\Merchant\Accounts\V1\AccountService;
use Google\Shopping\Merchant\Accounts\V1\Client\AccountServicesServiceClient;
use Google\Shopping\Merchant\Accounts\V1\ProposeAccountServiceRequest;
/**
* This class demonstrates how to propose an account service.
*/
class ProposeAccountServiceSample
{
/**
* A helper function to create the account name string.
*
* @param string $accountId The ID of the account.
*
* @return string The account name has the format: `accounts/{account_id}`
*/
private static function toAccountName(string $accountId): string
{
return sprintf('accounts/%s', $accountId);
}
/**
* Proposes a new account service.
*
* @param array $config The configuration data used for authentication and
* getting the account ID.
* @param string $providerId The ID of the provider account.
*/
public static function proposeAccountService(
array $config,
string $providerId
): void {
// Gets the OAuth credentials to make the request.
$credentials = Authentication::useServiceAccountOrTokenFile();
// Creates options containing credentials for the client to use.
$options = ['credentials' => $credentials];
// Creates a client.
$accountServicesServiceClient = new AccountServicesServiceClient($options);
// Calls the API and catches and prints any network failures/errors.
try {
$accountAggregation = new AccountAggregation();
$accountService = (new AccountService())
->setAccountAggregation($accountAggregation);
$request = (new ProposeAccountServiceRequest())
->setParent(self::toAccountName($config['accountId']))
->setProvider(self::toAccountName($providerId))
->setAccountService($accountService);
print "Sending Propose AccountService request\n";
$response = $accountServicesServiceClient->proposeAccountService($request);
print "Proposed AccountService below\n";
print $response->serializeToJsonString(true) . PHP_EOL;
} catch (ApiException $e) {
printf("An error has occurred: %s%s", $e->getMessage(), PHP_EOL);
}
}
/**
* Helper to execute the sample.
*/
public function callSample(): void
{
$config = Config::generateConfig();
// Update this with the Merchant Center provider ID you want to get the
// relationship for.
$providerId = 111;
self::proposeAccountService($config, $providerId);
}
}
// Run the script
$sample = new ProposeAccountServiceSample();
$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.
"""This class demonstrates how to propose an account service."""
from
examples.authentication
import
configuration
from
examples.authentication
import
generate_user_credentials
from
google.shopping.merchant_accounts_v1
import
AccountAggregation
from
google.shopping.merchant_accounts_v1
import
AccountService
from
google.shopping.merchant_accounts_v1
import
AccountServicesServiceClient
from
google.shopping.merchant_accounts_v1
import
ProposeAccountServiceRequest
_ACCOUNT
=
configuration
.
Configuration
()
.
read_merchant_info
()
_PARENT
=
f
"accounts/
{
_ACCOUNT
}
"
def
propose_account_service
(
provider_id
:
int
)
-
> None
:
"""Proposes an account service.
Args:
provider_id: The Merchant Center ID of the provider.
"""
# Gets OAuth Credentials.
credentials
=
generate_user_credentials
.
main
()
# Creates a client.
client
=
AccountServicesServiceClient
(
credentials
=
credentials
)
# Creates the provider resource name from the provider ID.
provider
=
f
"accounts/
{
provider_id
}
"
# Creates an AccountService object.
# For this request, only `account_aggregation` is needed.
account_service
=
AccountService
()
account_service
.
account_aggregation
=
AccountAggregation
()
# Creates the request.
request
=
ProposeAccountServiceRequest
(
parent
=
_PARENT
,
provider
=
provider
,
account_service
=
account_service
,
)
# Makes the request and catches and prints any error messages.
try
:
print
(
"Sending Propose AccountService request"
)
response
=
client
.
propose_account_service
(
request
=
request
)
print
(
"Proposed AccountService below"
)
print
(
response
)
except
RuntimeError
as
e
:
print
(
e
)
if
__name__
==
"__main__"
:
# Update this with the Merchant Center provider ID you want to get the
# relationship for.
provider_id_
=
111
propose_account_service
(
provider_id_
)