goark/pa-api

APIs for Amazon Product Advertising API v5 by Golang

pa-api -- APIs for Amazon Product Advertising API v5 by Golang

This package is required Go 1.16 or later.

Migrated repository to github.com/goark/pa-api

Usage

Create PA-API Information

Default PA-API information.

sv := paapi5.New() //Create default server
fmt.Println("Marketplace:", sv.Marketplace())
fmt.Println("Region:", sv.Region())
fmt.Println("AcceptLanguage:", sv.AcceptLanguage())
fmt.Println("URL:", sv.URL(paapi5.GetItems.Path()))
// Output:
// Marketplace: www.amazon.com
// Region: us-east-1
// AcceptLanguage: en_US
// URL: https://webservices.amazon.com/paapi5/getitems

PA-API information for Japan region.

sv := paapi5.New(paapi5.WithMarketplace(paapi5.LocaleJapan)) //Create server in Japan region
fmt.Println("Marketplace:", sv.Marketplace())
fmt.Println("Region:", sv.Region())
fmt.Println("AcceptLanguage:", sv.AcceptLanguage())
fmt.Println("URL:", sv.URL(paapi5.GetItems.Path()))
// Output:
// Marketplace: www.amazon.co.jp
// Region: us-west-2
// AcceptLanguage: ja_JP
// URL: https://webservices.amazon.co.jp/paapi5/getitems

Create Client Instance

Create default client instance.

client := paapi5.DefaultClient("mytag-20", "AKIAIOSFODNN7EXAMPLE", "1234567890") //Create default client
fmt.Println("Marketplace:", client.Marketplace())
// Output:
// Marketplace: www.amazon.com

Create client instance for Japan region.

//Create client for Janan region
client := paapi5.New(
    paapi5.WithMarketplace(paapi5.LocaleJapan),
).CreateClient(
    "mytag-20",
    "AKIAIOSFODNN7EXAMPLE",
    "1234567890",
    paapi5.WithHttpClient(http.DefaultClient),
)
fmt.Println("Marketplace:", client.Marketplace())
// Output:
// Marketplace: www.amazon.co.jp

Sample code

Operation GetItems

package main

import (
    "context"
    "fmt"

    paapi5 "github.com/goark/pa-api"
    "github.com/goark/pa-api/entity"
    "github.com/goark/pa-api/query"
)

func main() {
    //Create client
    client := paapi5.New(
        paapi5.WithMarketplace(paapi5.LocaleJapan),
    ).CreateClient(
        "mytag-20",
        "AKIAIOSFODNN7EXAMPLE",
        "1234567890",
    )

    //Make query
    q := query.NewGetItems(
        client.Marketplace(),
        client.PartnerTag(),
        client.PartnerType(),
    ).ASINs([]string{"B07YCM5K55"}).EnableImages().EnableItemInfo().EnableParentASIN()

    //Requet and response
    body, err := client.RequestContext(context.Background(), q)
    if err != nil {
        fmt.Printf("%+v\n", err)
        return
    }
    //io.Copy(os.Stdout, bytes.NewReader(body))

    //Decode JSON
    res, err := entity.DecodeResponse(body)
    if err != nil {
        fmt.Printf("%+v\n", err)
        return
    }
    fmt.Println(res.String())
}

Operation GetVariations

package main

import (
    "context"
    "fmt"

    paapi5 "github.com/goark/pa-api"
    "github.com/goark/pa-api/entity"
    "github.com/goark/pa-api/query"
)

func main() {
    //Create client
    client := paapi5.New(
        paapi5.WithMarketplace(paapi5.LocaleJapan),
    ).CreateClient(
        "mytag-20",
        "AKIAIOSFODNN7EXAMPLE",
        "1234567890",
    )

    //Make query
    q := query.NewGetVariations(
        client.Marketplace(),
        client.PartnerTag(),
        client.PartnerType(),
    ).ASIN("B07YCM5K55").EnableImages().EnableItemInfo().EnableParentASIN()

    //Request and response
    body, err := client.RequestContext(context.Background(), q)
    if err != nil {
        fmt.Printf("%+v\n", err)
        return
    }
    //io.Copy(os.Stdout, bytes.NewReader(body))

    //Decode JSON
    res, err := entity.DecodeResponse(body)
    if err != nil {
        fmt.Printf("%+v\n", err)
        return
    }
    fmt.Println(res.String())
}

Operation SearchItems

package main

import (
    "context"
    "fmt"

    paapi5 "github.com/goark/pa-api"
    "github.com/goark/pa-api/entity"
    "github.com/goark/pa-api/query"
)

func main() {
    //Create client
    client := paapi5.New(
        paapi5.WithMarketplace(paapi5.LocaleJapan),
    ).CreateClient(
        "mytag-20",
        "AKIAIOSFODNN7EXAMPLE",
        "1234567890",
    )

    //Make query
    q := query.NewSearchItems(
        client.Marketplace(),
        client.PartnerTag(),
        client.PartnerType(),
    ).Search(query.Keywords, "数学ガール").EnableImages().EnableItemInfo().EnableParentASIN()

    //Request and response
    body, err := client.RequestContext(context.Background(), q)
    if err != nil {
        fmt.Printf("%+v\n", err)
        return
    }
    //io.Copy(os.Stdout, bytes.NewReader(body))

    //Decode JSON
    res, err := entity.DecodeResponse(body)
    if err != nil {
        fmt.Printf("%+v\n", err)
        return
    }
    fmt.Println(res.String())
}

Operation GetBrowseNodes

package main

import (
    "context"
    "fmt"

    paapi5 "github.com/goark/pa-api"
    "github.com/goark/pa-api/entity"
    "github.com/goark/pa-api/query"
)

func main() {
    //Create client
    client := paapi5.New(
        paapi5.WithMarketplace(paapi5.LocaleJapan),
    ).CreateClient(
        "mytag-20",
        "AKIAIOSFODNN7EXAMPLE",
        "1234567890",
    )

    //Make query
    q := query.NewGetBrowseNodes(
        client.Marketplace(),
        client.PartnerTag(),
        client.PartnerType(),
    ).BrowseNodeIds([]string{"3040", "3045"}).EnableBrowseNodes()

    //Request and response
    body, err := client.RequestContext(context.Background(), q)
    if err != nil {
        fmt.Printf("%+v\n", err)
        return
    }

    //Decode JSON
    res, err := entity.DecodeResponse(body)
    if err != nil {
        fmt.Printf("%+v\n", err)
        return
    }
    fmt.Println(res.String())
}

Contributors

Many thanks for contributors

Links

• Go 言語用 PA-API v5 クライアント・パッケージ — リリース情報 | text.Baldanders.info

pa-api's Issues

Enable to get browse node Info

Hello everyone,

I want to get BrowseNode information through GetBrowseNodes operation on paapi5.
https://webservices.amazon.com/paapi5/documentation/getbrowsenodes.html

Usecase

I would like to get BrowseNode information as SearchItems and GetItems operations in pa-api library like below.

//Make query
    q := query.GetBrowseNodes(
        client.Marketplace(),
        client.PartnerTag(),
        client.PartnerType(),
    ). BrowseNodeIds([]string{"3040", "3045"})

`ParentASIN` attribute not present in `Item` struct

First of all great work with the go PAapi, it was really helpful.

The issue here is that the response mapping process is missing an attribute ParentASIN in the Item struct.
If the selected ASIN is a variant option (e.x. https://www.amazon.com/dp/B08GQHCJVZ) and it has the EnabEnableParentASIN the Response > Item struct does not seem to have that property.

Enable to mock up the generation of "X-Amz-Date"

Hi, @isaka1022 san.

I would like to be able to mock time generation(time.Now()) when running unit tests.
I tried to write the code like above, but if you have a better way, please let me know.

Usecase

import (
	"github.com/dnaeon/go-vcr/recorder"

	paapi5 "github.com/goark/pa-api"
	"github.com/goark/pa-api/query"
)


func Test(t *testing.T) {
	t.Run("tests", func(t *testing.T) {
		r, err := recorder.New(path)
		if err != nil {
			t.Fatal(err)
		}
		defer r.Stop()

		client := &http.Client{
			Transport: r,
		}

		amazon := paapi5.New().
			CreateClient(
				tag, access, secret,
				paapi5.WithHttpClient(client),
			)

		ctx := context.Background()
		q := query.NewSearchItems(...)

		// It would be nice to be able to mock up time generation when requesting here.
		content, err := amazon.RequestContext(ctx, q)
		if err != nil {
			t.Fatal(err)
		}
	})
}

Proposal

 func (c *client) post(ctx context.Context, cmd Operation, payload []byte) ([]byte, error) {
-       dt := NewTimeStamp(time.Now())
+       dt := NewTimeStamp(contextGetTime(ctx))
        u := c.server.URL(cmd.Path())
        hds := newHeaders(c.server, cmd, dt)
        sig := c.signiture(c.signedString(hds, payload), hds)
@@ -188,6 +188,20 @@ func (h *headers) values() string {
        return strings.Join(list, "\n")
 }
 
+type ctxTimeKey struct{}
+
+func ContextSetTime(ctx context.Context, t time.Time) context.Context {
+       return context.WithValue(ctx, ctxTimeKey{}, t)
+}
+
+func contextGetTime(ctx context.Context) time.Time {
+       val := ctx.Value(ctxTimeKey{})
+       if t, ok := val.(time.Time); !ok {
+               return t
+       }
+       return time.Now()
+}

Can't update the package because of wrong reference to errs package

Hi! I was looking for some update in a project, and when I typed

go get -u github.com/spiegel-im-spiegel/pa-api

here's what I got:

go get: github.com/spiegel-im-spiegel/[email protected]: parsing go.mod:
        module declares its path as: github.com/goark/errs
                but was required as: github.com/spiegel-im-spiegel/errs

I guess this line should be updated according to the new errs package location 😄