Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/billgerrard/google-content-api
Google::ContentAPI - Perl module to interact with Google's Content API for Shopping
https://github.com/billgerrard/google-content-api
adwords content-api google google-api hacktoberfest perl shopping
Last synced: about 1 month ago
JSON representation
Google::ContentAPI - Perl module to interact with Google's Content API for Shopping
- Host: GitHub
- URL: https://github.com/billgerrard/google-content-api
- Owner: billgerrard
- License: other
- Created: 2018-03-23T19:03:16.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2020-12-11T22:59:19.000Z (about 4 years ago)
- Last Synced: 2023-08-20T23:18:46.911Z (over 1 year ago)
- Topics: adwords, content-api, google, google-api, hacktoberfest, perl, shopping
- Language: Perl
- Homepage: https://metacpan.org/pod/Google::ContentAPI
- Size: 18.6 KB
- Stars: 1
- Watchers: 1
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.pod
- Changelog: Changes
- License: LICENSE
Awesome Lists containing this project
README
=head1 NAME
Google::ContentAPI - Interact with Google's Content API for Shopping
=head1 DESCRIPTION
Add, modify and delete items from the Google Merchant Center platform via
the Content API for Shopping.
Authentication is done via Service Account credentials. See the following for details:
L
You will also need to create a Merchant Center Account:
L
For convenience, add your Merchant account ID to the *.json file provided by Google.
Your complete *.json file, after adding your merchant ID, will look something like this:
{
"endpoint": "https://www.googleapis.com/content/v2.1",
"merchant_id": "123456789",
"type": "service_account",
"project_id": "content-api-194321",
"private_key_id": "11b8e20c2540c788e98b49e623ae8167dc3e4a6f",
"private_key": "-----BEGIN PRIVATE KEY-----
...
-----END PRIVATE KEY-----\n",
"client_email": "[email protected]",
"client_id": "999999999",
"auth_uri": "https://accounts.google.com/o/oauth2/auth",
"token_uri": "https://accounts.google.com/o/oauth2/token",
"auth_provider_x509_cert_url": "https://www.googleapis.com/oauth2/v1/certs",
"client_x509_cert_url": "https://www.googleapis.com/robot/v1/metadata/x509/google%40content-api.iam.gserviceaccount.com"
}
=head1 SYNOPSIS
use Google::ContentAPI;
use Data::Dumper;
my $google = Google::ContentAPI->new({
endpoint => 'https://www.googleapis.com/content/v2.1',
debug => 0,
config_file => 'content-api-key.json',
config_json => $json_text,
merchant_id => '123456789',
});
my ($result, $products, $batch_id, $product_id);
# get account auth info (merchantId)
$result = $google->get(
resource => 'accounts',
method => 'authinfo'
);
print "$result->{code} ". ($result->{code} eq '200' ? 'success' : 'failure') ."\n";
print "authinfo: \n". Dumper $result;
# get status of your merchant center account
$result = $google->get(
resource => 'accountstatuses',
method => 'get',
id => $google->{merchant_id} # your merchant ID unless working with multi-client account
);
print "$result->{code} ". ($result->{code} eq '200' ? 'success' : 'failure') ."\n";
print "Account status: \n". Dumper $result;
# list status of multi-client accounts (MCA)
# This will fail with response code 403 if the account is not a multi-client account.
$result = $google->get(
resource => 'accountstatuses',
method => 'list',
params => ['maxResults' => 10]
);
print "$result->{code} ". ($result->{code} eq '200' ? 'success' : 'failure') ."\n";
print "Account status: \n". Dumper $result;
# list products
$result = $google->get(
resource => 'products',
method => 'list',
);
print "$result->{code} ". ($result->{code} eq '200' ? 'success' : 'failure') ."\n";
print "Products list: \n". Dumper $result;
# insert a product
$result = $google->post(
resource => 'products',
method => 'insert',
body => {
contentLanguage => 'en',
targetCountry => 'US',
channel => 'online',
offerId => '333333',
title => 'Item title',
description => 'The item description',
link => 'http://www.google.com',
imageLink => 'https://www.google.com/images/logo.png',
availability => 'in stock',
condition => 'new',
price => {
value => '99.95',
currency => 'USD',
},
shipping => [
{
country => 'US',
service => 'Standard Shipping',
price => {
value => '7.95',
currency => 'USD',
},
},
],
brand => 'Apple',
gtin => '333333-67890',
mpn => '333333',
googleProductCategory => 'Home & Garden > Household Supplies > Apples',
productTypes => 'Home & Garden > Household Supplies > Apples',
customLabel1 => 'apples'
}
);
print "$result->{code} ". ($result->{code} eq '200' ? 'success' : 'failure') ."\n";
# get single product info
$product_id = '333333';
$result = $google->get(
resource => 'products',
method => 'get',
id => 'online:en:US:'. $product_id
);
print "$result->{code} ". ($result->{code} eq '200' ? 'success' : 'failure') ."\n";
print "Products info: \n". Dumper $result;
# delete a product
my $del_product_id = '333333';
$result = $google->delete(
resource => 'products',
method => 'delete',
id => 'online:en:US:'. $del_product_id,
);
print "$result->{code} ". ($result->{code} eq '204' ? 'success' : 'failure') ."\n"; # 204 = delete success
# batch insert
$products = [];
$batch_id = 0;
foreach my $i ('211203'..'211205') {
push @$products, {
batchId => ++$batch_id,
merchantId => $google->{merchant_id},
method => 'insert', # insert / get / delete
#productId => '', # for get / delete
product => { # for insert
contentLanguage => 'en',
targetCountry => 'US',
channel => 'online',
offerId => "$i",
title => "item title $i",
description => "The item description for $i",
link => 'http://www.google.com',
imageLink => 'https://www.google.com/images/logo.png',
availability => 'in stock',
condition => 'new',
price => {
value => '10.95',
currency => 'USD',
},
shipping => [
{
country => 'US',
service => 'Standard Shipping',
price => {
value => '7.95',
currency => 'USD',
},
},
],
brand => 'Apple',
gtin => "${i}-67890",
mpn => "$i",
googleProductCategory => 'Home & Garden > Household Supplies > Apples',
productTypes => 'Home & Garden > Household Supplies > Apples',
customLabel1 => 'apples'
}
};
}
$result = $google->post(
resource => 'products',
method => 'batch',
body => { entries => $products }
);
print "$result->{code} ". ($result->{code} eq '200' ? 'success' : 'failure') ."\n";
# batch get:
$products = [];
$batch_id = 0;
foreach my $product_id ('211203'..'211205') {
push @$products, {
batchId => ++$batch_id,
merchantId => $google->{merchant_id},
method => 'get', # insert / get / delete
productId => 'online:en:US:'. $product_id, # for get / delete
};
}
$result = $google->post(
resource => 'products',
method => 'batch',
body => { entries => $products }
);
print "$result->{code} ". ($result->{code} eq '200' ? 'success' : 'failure') ."\n";
print Dumper $result;
# batch delete:
$products = [];
$batch_id = 0;
foreach my $product_id ('211203'..'211205') {
push @$products, {
batchId => ++$batch_id,
merchantId => $google->{merchant_id},
method => 'delete', # insert / get / delete
productId => 'online:en:US:'. $product_id, # for get / delete
};
}
$result = $google->post(
resource => 'products',
method => 'batch',
body => { entries => $products }
);
print "$result->{code} ". ($result->{code} eq '200' ? 'success' : 'failure') ."\n";
# list status of products
$result = $google->get(
resource => 'productstatuses',
method => 'list',
params => [
'maxResults' => 10
]
);
print "$result->{code} ". ($result->{code} eq '200' ? 'success' : 'failure') ."\n";
print "Product status: \n". Dumper $result;
# get status of a specific product
$product_id = '333333';
$result = $google->get(
resource => 'productstatuses',
method => 'get',
id => 'online:en:US:'. $product_id
);
print "$result->{code} ". ($result->{code} eq '200' ? 'success' : 'failure') ."\n";
print "Product status: \n". Dumper $result;
=head1 METHODS AND FUNCTIONS
=head2 new()
Create a new Google::ContentAPI object
=head3 endpoint
API endpoint to use.
v2.1 endpoint is 'https://www.googleapis.com/content/v2.1'.
v2.0 endpoint is 'https://www.googleapis.com/content/v2'.
If not provided, default to v2.0 endpoint for backwards compatibility.
=head3 debug
Displays API debug information
=head3 config_file
Path and filename of external C<.json> config file.
Either config_file or config_json must be provided. If both config_file
and config_json are provided, config_file will be used.
=head3 config_json
Text containing contents of the json config. Useful if you want to
store the json config in another resource such as a database.
Either C or C must be provided. If both C
and C are provided, C will be used.
=head3 merchant_id
optional if merchant_id is specified in json config
=head2 ACCOUNTS
=head3 authinfo
Returns information about the authenticated user.
=head2 ACCOUNTSTATUSES
=head3 list
Lists the the status of accounts in a Multi-Client account.
This will fail with response code C<403> if the account is not a multi-client account.
=head3 get
Retrieves the status of your Merchant Center account.
=head2 PRODUCTS
=head3 custombatch
Retrieves, inserts, and deletes multiple products in a single request.
=head3 insert
Uploads a product to your Merchant Center account. If an item with the
same channel, contentLanguage, offerId, and targetCountry already exists,
this method updates that entry.
=head3 list
Lists the products in your Merchant Center account.
=head3 get
Retrieves a product from your Merchant Center account.
=head3 delete
Deletes a product from your Merchant Center account.
=head2 PRODUCTSTATUSES
=head3 list
Lists the the status and issues of products in your Merchant Center Account.
=head3 get
Retrieves the status and issues of a specific product.
=head1 UNIMPLEMENTED FEATURES
Certain API methods are not yet implemented (no current personal business need).
A "custom" resource is available to perform methods that are not implemented by
this module.
# get an order from the merchant account
$result = $google->get(
resource => 'custom',
method => 'merchantId/orders/orderId'
);
=head1 PREREQUISITES
JSON
Crypt::JWT
REST::Client
HTML::Entities
=head1 AUTHOR
Original Author
Bill Gerrard
=head1 COPYRIGHT AND LICENSE
Copyright (C) 2018,2020 Bill Gerrard
This library is free software; you can redistribute it and/or modify
it under the same terms as Perl itself, either Perl version 5.20.2 or,
at your option, any later version of Perl 5 you may have available.
Disclaimer of warranty: This program is provided by the copyright holder
and contributors "As is" and without any express or implied warranties.
The implied warranties of merchantability, fitness for a particular purpose,
or non-infringement are disclaimed to the extent permitted by your local
law. Unless required by law, no copyright holder or contributor will be
liable for any direct, indirect, incidental, or consequential damages
arising in any way out of the use of the package, even if advised of the
possibility of such damage.
=cut