seo-rich-snippets-yotpo-api.html

<script data-cfasync="false">
/*
    Web Site Advantage: Yotpo via API [v1.1] 
    Gathers Yotpo reviews via their API and creates structured data for th SEO Rich Snippets app
    https://bigcommerce.websiteadvantage.com.au/
    Copyright (C) 2023 Web Site Advantage
*/   
{{#if page_type '===' 'product' }}

!function(w,d){

    var yotpoAppKey = ''; // if left blank the code will attempt to discover the app key from the Yotpo widget
    var productId = {{{json product.id}}};
    var productUrl = {{{json product.url}}};

    // let someone specify the key from outside the script
    if (w.wsa_yotpoAppKey && !yotpoAppKey) {
        yotpoAppKey = w.wsa_yotpoAppKey;
    }

    function getYotopAppKey() {
        // V3 script
        var scriptElement = document.querySelector('script[src*="yotpo.com/v1/loader/"]');

        if (scriptElement) {
            var src = scriptElement.getAttribute('src');
            return src.split('/').pop();
        }

        // older script
        var scripts = document.getElementsByTagName('script');
        var pattern = /\/\/staticw2\.yotpo\.com\/(.*?)\/widget\.js/g;
        
        for (var i = 0; i < scripts.length; i++) {
            var scriptContent = scripts[i].textContent || scripts[i].innerText;
            var match;
        
            while ((match = pattern.exec(scriptContent)) !== null) {
                var key = match[1];
                return key;
            }
        }   
    }

    function getReviews() {
        var apiUrl = 'https://api-cdn.yotpo.com/v3/storefront/store/' + yotpoAppKey + '/product/' + productId +'/reviews?page=1&perPage=5&sort=date,images,badge,rating';

        fetch(apiUrl, {
            method: 'GET'
        })
        .then(function (response) {
            return response.json();
        })
        .then(function (result) {
            if (result.reviews.length > 0) {
        
                let jsonLd = {
                    "@context": "https://schema.org/",
                    "@type": "Product",
                    "@id": productUrl + "#Product" + w.wsa_jsonLdIdPostfix, // add postfix
                    "aggregateRating": {
                        "@type": "AggregateRating",
                        "worstRating": "1",
                        "bestRating": "5",
                        "ratingValue": result.bottomline.averageScore,
                        "reviewCount": result.bottomline.totalReview
                    },
                    "review": []
                };
        
        
                for (var i = 0; i < result.reviews.length; i++) {
                    var review = result.reviews[i];
        
                    jsonLd.review.push({
                        "@type": "Review",
                        "author": {
                            "@type": "Person",
                            "name": review.user.displayName
                        },
                        "reviewRating": {
                            "@type": "Rating",
                            "ratingValue": review.score
                        },
                        "name": review.title,
                        "reviewBody": review.content,
                        "datePublished": review.createdAt
                    });
                }

                console.log('jsonLd', jsonLd);

        
                if (!webSiteAdvantage.excludeProduct) {
                    let aggregateRatingScriptElement = d.createElement('script');
                    aggregateRatingScriptElement.type = 'application/ld+json';
                    aggregateRatingScriptElement.setAttribute("id", 'wsa-rich-snippets-jsonld-yotpo-product' + w.wsa_jsonLdIdPostfix.toLowerCase());
                    let inlineScript = d.createTextNode(JSON.stringify(jsonLd));
                    aggregateRatingScriptElement.appendChild(inlineScript);
                    d.querySelector('head').appendChild(aggregateRatingScriptElement);
                }
            }
        });
    }

    if (yotpoAppKey) {
        getReviews();
    }
    else {
        yotpoAppKey = getYotopAppKey();
        if (yotpoAppKey) {
            getReviews();
        }
        else {
            addEventListener('DOMContentLoaded', function() {
                yotpoAppKey = getYotopAppKey();
                if (yotpoAppKey) {
                    getReviews();
                }
            });
        }
    }
}(window, document)
{{/if}}
</script>