AI-generated Key Takeaways
-
This webpage provides code samples in Java, PHP, and Python demonstrating how to list promotions using the Merchant API.
-
The code examples showcase the use of the
ListPromotionsRequestto retrieve a list of promotions associated with a specific account. -
Each code sample iterates through the returned promotions and prints the details and count, offering a way to see all promotions for a merchant.
-
The Java, PHP, and Python samples include instructions for handling authentication, creating the request, and processing the response from the Promotions Service.
Merchant API code sample to list promotions.
Java
// Copyright 2023 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.promotions.v1
;
import
com.google.api.gax.core.FixedCredentialsProvider
;
import
com.google.auth.oauth2.GoogleCredentials
;
import
com.google.shopping.merchant.promotions.v1.ListPromotionsRequest
;
import
com.google.shopping.merchant.promotions.v1.Promotion
;
import
com.google.shopping.merchant.promotions.v1.PromotionsServiceClient
;
import
com.google.shopping.merchant.promotions.v1.PromotionsServiceClient.ListPromotionsPagedResponse
;
import
com.google.shopping.merchant.promotions.v1.PromotionsServiceSettings
;
import
shopping.merchant.samples.utils.Authenticator
;
import
shopping.merchant.samples.utils.Config
;
/** This class demonstrates how to list promotions. */
public
class
ListPromotionsSample
{
public
static
void
listPromotions
(
String
accountId
)
throws
Exception
{
GoogleCredentials
credential
=
new
Authenticator
().
authenticate
();
PromotionsServiceSettings
promotionsServiceSettings
=
PromotionsServiceSettings
.
newBuilder
()
.
setCredentialsProvider
(
FixedCredentialsProvider
.
create
(
credential
))
.
build
();
try
(
PromotionsServiceClient
promotionsServiceClient
=
PromotionsServiceClient
.
create
(
promotionsServiceSettings
))
{
ListPromotionsRequest
request
=
ListPromotionsRequest
.
newBuilder
()
.
setParent
(
String
.
format
(
"accounts/%s"
,
accountId
))
.
build
();
System
.
out
.
println
(
"Sending list promotions request:"
);
ListPromotionsPagedResponse
response
=
promotionsServiceClient
.
listPromotions
(
request
);
int
count
=
0
;
// Iterates over all rows in all pages and prints the datasource in each row.
// Automatically uses the `nextPageToken` if returned to fetch all pages of data.
for
(
Promotion
promotion
:
response
.
iterateAll
())
{
System
.
out
.
println
(
promotion
);
count
++
;
}
System
.
out
.
print
(
"The following count of promotions were returned: "
);
System
.
out
.
println
(
count
);
}
catch
(
Exception
e
)
{
System
.
out
.
println
(
"Failed to list promotions."
);
System
.
out
.
println
(
e
);
}
}
public
static
void
main
(
String
[]
args
)
throws
Exception
{
Config
config
=
Config
.
load
();
listPromotions
(
config
.
getAccountId
().
toString
());
}
}
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\Promotions\V1\ListPromotionsRequest;
use Google\Shopping\Merchant\Promotions\V1\Promotion;
use Google\Shopping\Merchant\Promotions\V1\Client\PromotionsServiceClient;
/**
* This class demonstrates how to list promotions.
*/
class ListPromotions
{
/**
* Lists promotions for the given account.
*
* @param array $config
* The configuration data used for authentication and getting the account ID.
* @return void
*/
public static function listPromotionsSample($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.
$promotionsServiceClient = new PromotionsServiceClient($options);
try {
// Creates the request.
$request = new ListPromotionsRequest([
'parent' => sprintf('accounts/%s', $config['accountId']),
]);
print "Sending list promotions request:\n";
// Makes the request.
$response = $promotionsServiceClient->listPromotions($request);
$count = 0;
// Iterates over all promotions returned in the response.
foreach ($response->iterateAllElements() as $promotion) {
print_r($promotion);
$count++;
}
printf("The following count of promotions were returned: %s\n", $count);
} catch (ApiException $e) {
printf("Failed to list promotions.\n");
print $e->getMessage();
}
}
/**
* Helper to execute the sample.
*
* @return void
*/
public function callSample(): void
{
$config = Config::generateConfig();
// Makes the call to list promotions.
self::listPromotionsSample($config);
}
}
// Run the script
$sample = new ListPromotions();
$sample->callSample();
