NAME
Bing::ContentAPI - Perl interface to the Bing Ads / Microsoft Advertising Content API
|
DESCRIPTION
Add, modify and delete products from the Microsoft Advertising Merchant Center platform
via the Bing Ads / Microsoft Advertising Content API.
Authentication is done via OAuth using Authorization Code Grant Flow
Follow the steps to register an application with the Microsoft identity platform:
Set up a Redirect URI. Set up a Mobile/Desktop app redirect URI (not a Web application redirect).
Steps to authorize a native application and generate an initial refresh token:
Note: Substitute CLIENT_ID, REDIRECT_URI and AUTHORIZATION_CODE with the
actual values in the appropriate locations in the examples.
1) Request user consent through web browser:
(using an existing Bing Ads / Microsoft Advertising account when prompted)
Response received:
2) Use the authorization 'code' received to request the access token and refresh token.
Note: scope must include 'offline_access', as included in the example, to receive a refresh token.
$ curl \
-d client_id=CLIENT_ID \
-d code=AUTHORIZATION_CODE \
-d grant_type=authorization_code \
-d redirect_uri=REDIRECT_URI \
-d scope=offline_access%20https%3A%2F%2Fads.microsoft.com%2Fmsads.manage \
-H "Content-Type: application/x-www-form-urlencoded" \
Response:
{
"token_type": "Bearer",
"expires_in": 3600,
"ext_expires_in": 3600,
"access_token": "...",
"refresh_token": "..."
}
3) Use the received refresh_token as the initial refresh_token in Bing::ContentAPI->new()
|
SYNOPSIS
my $bing = Bing::ContentAPI->new({
debug => 0,
merchant_id => '12345',
developer_token => '123ABC456DEF789',
client_id => '1234abcd-5679-efgh-123456789',
refresh_token => load_token(),
});
save_token($bing->{refresh_token});
sub load_token {
my $token;
return $token;
}
sub save_token {
my $token = shift;
}
my ($request, $result, $products, $batch_id, $product_id);
my $nextPageToken = '';
do {
$request = {
resource => 'products',
method => 'list',
params => ['max-results' => 250],
};
push @{$request->{params}}, ('start-token', "$nextPageToken") if $nextPageToken ne '';
$result = $bing->get(%$request);
$nextPageToken = $result->{response}->{nextPageToken} || '';
print "$result->{code} ". ($result->{code} eq '200' ? 'success' : 'failure') ."\n";
print "Products list: \n". Dumper $result;
} while ($nextPageToken ne '');
$result = $bing->get(
resource => 'catalogs',
method => 'list',
);
print "$result->{code} ". ($result->{code} eq '200' ? 'success' : 'failure') ."\n";
print "Catalogs list: \n". Dumper $result;
my $catalogID = 123456;
$result = $bing->get(
resource => 'catalogs',
method => 'status',
id => $catalogID,
);
print "$result->{code} ". ($result->{code} eq '200' ? 'success' : 'failure') ."\n";
print "Catalog status: \n". Dumper $result;
$result = $bing->post(
resource => 'products',
method => 'insert',
dryrun => 1,
body => {
contentLanguage => 'en',
targetCountry => 'US',
channel => 'online',
offerId => '333333',
title => 'Item title',
description => 'The item description',
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 => '33333367890',
mpn => '333333',
googleProductCategory => 'Home & Garden > Household Supplies > Household Paper Products > Paper Towels',
productType => 'Home & Garden > Household Supplies > Household Paper Products > Paper Towels',
customLabel1 => 'Paper Towels'
}
);
print "$result->{code} ". ($result->{code} eq '200' ? 'success' : 'failure') ."\n";
$product_id = '333333';
$result = $bing->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;
print "product delete: ";
my $del_product_id = '333333';
$result = $bing->delete(
resource => 'products',
method => 'delete',
id => 'online:en:US:'. $del_product_id,
dryrun => 1,
);
print "$result->{code} ". ($result->{code} eq '204' ? 'success' : 'failure') ."\n";
print Dumper $result;
$products = [];
$batch_id = 0;
foreach my $i ('211203'..'211205') {
push @$products, {
batchId => ++$batch_id,
merchantId => $bing->{merchant_id},
method => 'insert',
product => {
contentLanguage => 'en',
targetCountry => 'US',
channel => 'online',
offerId => "$i",
title => "item title $i",
description => "The item description for $i",
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 > Household Paper Products > Paper Towels',
productType => 'Home & Garden > Household Supplies > Household Paper Products > Paper Towels',
customLabel1 => 'Paper Towels'
}
};
}
$result = $bing->post(
resource => 'products',
method => 'batch',
dryrun => 1,
body => { entries => $products }
);
print "$result->{code} ". ($result->{code} eq '200' ? 'success' : 'failure') ."\n";
$products = [];
$batch_id = 0;
foreach my $product_id ('211203'..'211209') {
push @$products, {
batchId => ++$batch_id,
merchantId => $bing->{merchant_id},
method => 'get',
productId => 'online:en:US:'. $product_id,
};
}
$result = $bing->post(
resource => 'products',
method => 'batch',
dryrun => 1,
body => { entries => $products }
);
print "$result->{code} ". ($result->{code} eq '200' ? 'success' : 'failure') ."\n";
print Dumper $result;
$products = [];
$batch_id = 0;
foreach my $product_id ('211203'..'211205') {
push @$products, {
batchId => ++$batch_id,
merchantId => $bing->{merchant_id},
method => 'delete',
productId => 'online:en:US:'. $product_id,
};
}
$result = $bing->post(
resource => 'products',
method => 'batch',
dryrun => 1,
body => { entries => $products }
);
print "$result->{code} ". ($result->{code} eq '200' ? 'success' : 'failure') ."\n";
|
METHODS AND FUNCTIONS
new()
Create a new Bing::ContentAPI object
|
debug
Displays API debug information
|
merchant_id
developer_token
client_id
Client ID is the Application ID value in "Registering Your Application":
|
redirect_uri
Redirect URI is the Mobile/Desktop app redirect URI value in "Registering Your Application":
|
refresh_token
The current refresh token
|
refresh_access_token()
Using the current refresh_token, obtain a new access and refresh token
|
access_token
returns access_token obtained via refresh_access_token()
|
refresh_token
returns refresh_token obtained via refresh_access_token()
|
PRODUCTS
batch
Retrieves, inserts, and deletes multiple products in a single request.
|
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.
|
list
Lists the products in your Merchant Center account.
|
get
Retrieves a product from your Merchant Center account.
|
delete
Deletes a product from your Merchant Center account.
|
CATALOGS
list
Lists the catalogs in your Merchant Center Account.
|
status
Lists the status and issues of products offers in your Merchant Center Account.
|
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.
$result = $bing->get(
resource => 'custom',
method => 'merchantId/orders/orderId'
);
|
PREREQUISITES
JSON
REST::Client
HTML::Entities
|
AUTHOR
Original Author
Bill Gerrard <bill@gerrard.org>
|
COPYRIGHT AND LICENSE
Copyright (C) 2018-2022 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 thepossibility of such damage.
|