README_en.md

URL Submitter

urlsubmitter is a Go package designed for SEO purposes, enabling you to submit URLs to various search engines and services, including Baidu, Microsoft IndexNow, and Google Indexing API.

中文版

Features

• Submit URLs to Baidu
• Submit URLs to Microsoft IndexNow
• Submit URLs to Google Indexing API

Installation

First, make sure you have Go installed. Then, you can install the urlsubmitter package with the following command:

go get github.com/axiaoxin-com/urlsubmitter

Sure, here's the translated content:

Important Notice Before Use

Before using the Google Indexing API and Bing IndexNow, some preliminary preparation is required. You can refer to the following articles:

• SEO | How to Quickly Notify Google to Crawl Updated Pages Using Golang
• SEO | Accelerate Bing's Crawling of Your Pages: Application of Golang with Bing IndexNow

Usage Example

Here is an example of how to use the urlsubmitter package:

package main

import (
    "fmt"
    "log"

    "github.com/axiaoxin-com/urlsubmitter"
)

func main() {
    // Initialize Baidu submitter
    baiduSubmitter := urlsubmitter.NewBaiduSubmitter("http://data.zz.baidu.com/urls?site=https://www.example.org&token=baidutoken")

    // Initialize Bing submitter
    bingSubmitter := urlsubmitter.NewBingSubmitter(
        "www.example.org",
        "bingkey",
        "https://www.example.org/keylocation.txt",
    )

    // Initialize Google submitter
    googleSubmitter := urlsubmitter.NewGoogleSubmitter("/path/to/your-svc-account-keys.json")

    urls := []string{
        "http://www.example.org/1.html",
        "http://www.example.org/2.html",
    }

    // Submit URLs to Baidu
    baiduResult, err := baiduSubmitter.SubmitURLs(urls)
    if err != nil {
        log.Fatalf("Error submitting to Baidu: %v", err)
    }
    fmt.Println("Baidu Result:", baiduResult)

    // Submit URLs to Bing
    bingResult, err := bingSubmitter.SubmitURLs(urls)
    if err != nil {
        log.Fatalf("Error submitting to Bing: %v", err)
    }
    fmt.Println("Bing Result:", bingResult)

    // Submit URLs to Google
    googleResult, err := googleSubmitter.SubmitURLs(urls)
    if err != nil {
        log.Fatalf("Error submitting to Google: %v", err)
    }
    fmt.Println("Google Result:", googleResult)
}

UniversalSubmitter example:

package main

import (
	"fmt"
	"log"
	"os"

	"github.com/axiaoxin-com/urlsubmitter"
)

func main() {
	options := &urlsubmitter.UniversalOptions{
		BaiduAPI:            os.Getenv("BAIDU_API"),
		BingKey:             os.Getenv("BING_KEY"),
		BingKeyLocation:     os.Getenv("BING_KEY_LOCATION"),
		BingHost:            os.Getenv("BING_SUBMIT_HOST"),
		GoogleCredentialsFile: os.Getenv("GOOGLE_CREDENTIALS_FILE"),
	}

	universal := urlsubmitter.NewUniversalSubmitter(options)
	if universal == nil {
		log.Fatal("No valid submitter configurations provided.")
	}

	urls := []string{
		"http://www.example.com/1.html",
		"http://www.example.com/2.html",
		"https://www.example.org/url1",
		"https://www.example.org/folder/url2",
		"https://example.com/new-url/",
	}

	results, err := universal.SubmitURLs(urls)
	if err != nil {
		log.Fatalf("Failed to submit URLs: %v", err)
	}

	for platform, result := range results {
		fmt.Printf("%s: %s\n", platform, result)
	}
}

Running Unit Tests

You can run unit tests using the following commands, ensuring you set the necessary environment variables:

# Environment variables
export SUBMIT_URL="URL to submit"
export BAIDU_API="Baidu API"
export BING_SUBMIT_HOST="Bing host parameter"
export BING_KEY="Bing key parameter"
export BING_KEY_LOCATION="Bing keyLocation parameter"
export GOOGLE_CREDENTIALS_FILE="Google credentials file parameter"

Run the tests:

go test ./...

Contributing

Issues and Pull Requests are welcome. Please ensure all tests pass and adhere to the project's coding standards before submitting a Pull Request.

Thank you for using urlsubmitter! We hope it helps streamline your URL submission process.