appstoreconnect

README

go-appstoreconnect

Go client library for App Store Connect API

Documentation

Index

• Constants
• type Client
  • func NewClient(urlStr string, token string, logger *log.Logger) (*Client, error)
  • func (c *Client) DownloadFinanceReports(ctx context.Context, q *DownloadFinanceReportsQuery, out io.Writer) error
  • func (c *Client) ListAllInAppPurchasesForAnApp(ctx context.Context, id string, q *ListAllInAppPurchasesForAnAppQuery) (*ListAllInAppPurchasesForAnAppResponse, error)
  • func (c *Client) ListApps(ctx context.Context, q *ListAppsQuery) (*ListAppsResponse, error)
• type DownloadFinanceReportsQuery
• type ListAllInAppPurchasesForAnAppQuery
• type ListAllInAppPurchasesForAnAppResponse
• type ListAppsQuery
• type ListAppsResponse
• type Token
  • func NewToken(keyID string, issuerID string, lifetime time.Duration, scope []string) *Token
  • func (t *Token) Sign(p8key []byte) (string, error)

Constants

const BaseURL = "https://api.appstoreconnect.apple.com"

Types

type Client

type Client struct {
	URL        *url.URL
	HTTPClient *http.Client
	Token      string
	Logger     *log.Logger
}

func NewClient

func NewClient(urlStr string, token string, logger *log.Logger) (*Client, error)

func (*Client) DownloadFinanceReports

func (c *Client) DownloadFinanceReports(ctx context.Context, q *DownloadFinanceReportsQuery, out io.Writer) error

https://developer.apple.com/documentation/appstoreconnectapi/download_finance_reports

func (*Client) ListAllInAppPurchasesForAnApp

func (c *Client) ListAllInAppPurchasesForAnApp(ctx context.Context, id string, q *ListAllInAppPurchasesForAnAppQuery) (*ListAllInAppPurchasesForAnAppResponse, error)

func (*Client) ListApps

func (c *Client) ListApps(ctx context.Context, q *ListAppsQuery) (*ListAppsResponse, error)

https://developer.apple.com/documentation/appstoreconnectapi/list_apps

type DownloadFinanceReportsQuery

type DownloadFinanceReportsQuery struct {
	FilterRegionCode   []string `url:"filter[regionCode]"`
	FilterReportDate   []string `url:"filter[reportDate]"`
	FilterReportType   []string `url:"filter[reportType]"`
	FilterVendorNumber []string `url:"filter[vendorNumber]"`
}

type ListAllInAppPurchasesForAnAppQuery

type ListAllInAppPurchasesForAnAppQuery struct {
	FieldsInAppPurchaseAppStoreReviewScreenshots []string `url:"fields[inAppPurchaseAppStoreReviewScreenshots],omitempty"`
	FieldsInAppPurchaseContents                  []string `url:"fields[inAppPurchaseContents],omitempty"`
	FieldsInAppPurchaseLocalizations             []string `url:"fields[inAppPurchaseLocalizations],omitempty"`
	FieldsInAppPurchasePricePoints               []string `url:"fields[inAppPurchasePricePoints],omitempty"`
	FieldsInAppPurchases                         []string `url:"fields[inAppPurchases],omitempty"`
	FieldsPromotedPurchases                      []string `url:"fields[promotedPurchases],omitempty"`
	FilterInAppPurchaseType                      []string `url:"filter[inAppPurchaseType],omitempty"`
	FilterName                                   []string `url:"filter[name],omitempty"`
	FilterProductID                              []string `url:"filter[productId],omitempty"`
	FilterState                                  []string `url:"filter[state],omitempty"`
	Include                                      []string `url:"include,omitempty"`
	Limit                                        int      `url:"limit,omitempty"`
	LimitInAppPurchaseLocalizations              int      `url:"limit[inAppPurchaseLocalizations],omitempty"`
	LimitPricePoints                             int      `url:"limit[pricePoints],omitempty"`
	Sort                                         []string `url:"sort,omitempty"`
	FieldsInAppPurchasePriceSchedules            []string `url:"fields[inAppPurchasePriceSchedules],omitempty"`
}

type ListAllInAppPurchasesForAnAppResponse

type ListAllInAppPurchasesForAnAppResponse struct {
	Data []struct {
		Type       string `json:"type"`
		ID         string `json:"id"`
		Attributes struct {
			Name                      string      `json:"name"`
			ProductID                 string      `json:"productId"`
			InAppPurchaseType         string      `json:"inAppPurchaseType"`
			State                     string      `json:"state"`
			ReviewNote                interface{} `json:"reviewNote"`
			FamilySharable            bool        `json:"familySharable"`
			ContentHosting            interface{} `json:"contentHosting"`
			AvailableInAllTerritories bool        `json:"availableInAllTerritories"`
		} `json:"attributes"`
		Relationships struct {
			InAppPurchaseLocalizations struct {
				Links struct {
					Self    string `json:"self"`
					Related string `json:"related"`
				} `json:"links"`
			} `json:"inAppPurchaseLocalizations"`
			PricePoints struct {
				Links struct {
					Self    string `json:"self"`
					Related string `json:"related"`
				} `json:"links"`
			} `json:"pricePoints"`
			Content struct {
				Links struct {
					Self    string `json:"self"`
					Related string `json:"related"`
				} `json:"links"`
			} `json:"content"`
			AppStoreReviewScreenshot struct {
				Links struct {
					Self    string `json:"self"`
					Related string `json:"related"`
				} `json:"links"`
			} `json:"appStoreReviewScreenshot"`
			PromotedPurchase struct {
				Links struct {
					Self    string `json:"self"`
					Related string `json:"related"`
				} `json:"links"`
			} `json:"promotedPurchase"`
			IapPriceSchedule struct {
				Links struct {
					Self    string `json:"self"`
					Related string `json:"related"`
				} `json:"links"`
			} `json:"iapPriceSchedule"`
		} `json:"relationships"`
		Links struct {
			Self string `json:"self"`
		} `json:"links"`
	} `json:"data"`
	Links struct {
		Self string `json:"self"`
	} `json:"links"`
	Meta struct {
		Paging struct {
			Total int `json:"total"`
			Limit int `json:"limit"`
		} `json:"paging"`
	} `json:"meta"`
}

type ListAppsQuery

type ListAppsQuery struct {
	FieldsApps                          []string `url:"fields[apps],omitempty"`
	FieldsBetaLicenseAgreements         []string `url:"fields[betaLicenseAgreements],omitempty"`
	FilterBundleID                      []string `url:"filter[bundleId],omitempty"`
	FilterID                            []string `url:"filter[id],omitempty"`
	FilterName                          []string `url:"filter[name],omitempty"`
	FilterSKU                           []string `url:"filter[sku],omitempty"`
	Include                             []string `url:"include,omitempty"`
	Limit                               int      `url:"limit,omitempty"`
	Sort                                []string `url:"sort,omitempty"`
	FieldsPreReleaseVersions            []string `url:"fields[preReleaseVersions],omitempty"`
	LimitPreReleaseVersions             int      `url:"limit[preReleaseVersions],omitempty"`
	FieldsBetaAppReviewDetails          []string `url:"fields[betaAppReviewDetails],omitempty"`
	FieldsBetaAppLocalizations          []string `url:"fields[betaAppLocalizations],omitempty"`
	FieldsBuilds                        []string `url:"fields[builds],omitempty"`
	FieldsBetaGroups                    []string `url:"fields[betaGroups],omitempty"`
	LimitBuilds                         int      `url:"limit[builds],omitempty"`
	LimitBetaGroups                     int      `url:"limit[betaGroups],omitempty"`
	LimitBetaAppLocalizations           int      `url:"limit[betaAppLocalizations],omitempty"`
	LimitPrices                         int      `url:"limit[prices],omitempty"`
	LimitAvailableTerritories           int      `url:"limit[availableTerritories],omitempty"`
	LimitAppStoreVersions               int      `url:"limit[appStoreVersions],omitempty"`
	LimitAppInfos                       int      `url:"limit[appInfos],omitempty"`
	FieldsEndUserLicenseAgreements      []string `url:"fields[endUserLicenseAgreements],omitempty"`
	FieldsAppStoreVersions              []string `url:"fields[appStoreVersions],omitempty"`
	FieldsTerritories                   []string `url:"fields[territories],omitempty"`
	FieldsAppPrices                     []string `url:"fields[appPrices],omitempty"`
	FieldsAppPreOrders                  []string `url:"fields[appPreOrders],omitempty"`
	FieldsAppInfos                      []string `url:"fields[appInfos],omitempty"`
	FieldsPerfPowerMetrics              []string `url:"fields[perfPowerMetrics],omitempty"`
	FilterAppStoreVersions              []string `url:"filter[appStoreVersions],omitempty"`
	FilterAppStoreVersionsPlatform      []string `url:"filter[appStoreVersions.platform],omitempty"`
	FilterAppStoreVersionsAppStoreState []string `url:"filter[appStoreVersions.appStoreState],omitempty"`
	LimitGameCenterEnabledVersions      int      `url:"limit[gameCenterEnabledVersions],omitempty"`
	FieldsGameCenterEnabledVersions     []string `url:"fields[gameCenterEnabledVersions],omitempty"`
	ExistsGameCenterEnabledVersions     bool     `url:"exists[gameCenterEnabledVersions],omitempty"`
	LimitInAppPurchases                 int      `url:"limit[inAppPurchases],omitempty"`
	FieldsInAppPurchases                []string `url:"fields[inAppPurchases],omitempty"`
	FieldsCiProducts                    []string `url:"fields[ciProducts],omitempty"`
	LimitAppClips                       int      `url:"limit[appClips],omitempty"`
	FieldsAppClips                      []string `url:"fields[appClips],omitempty"`
	FieldsReviewSubmissions             []string `url:"fields[reviewSubmissions],omitempty"`
	FieldsAppCustomProductPages         []string `url:"fields[appCustomProductPages],omitempty"`
	FieldsAppEvents                     []string `url:"fields[appEvents],omitempty"`
	LimitAppCustomProductPages          int      `url:"limit[appCustomProductPages],omitempty"`
	LimitAppEvents                      int      `url:"limit[appEvents],omitempty"`
	LimitReviewSubmissions              int      `url:"limit[reviewSubmissions],omitempty"`
	FieldsAppPricePoints                []string `url:"fields[appPricePoints],omitempty"`
	FieldsCustomerReviews               []string `url:"fields[customerReviews],omitempty"`
	FieldsSubscriptionGracePeriods      []string `url:"fields[subscriptionGracePeriods],omitempty"`
	FieldsPromotedPurchases             []string `url:"fields[promotedPurchases],omitempty"`
	FieldsSubscriptionGroups            []string `url:"fields[subscriptionGroups],omitempty"`
	LimitInAppPurchasesV2               int      `url:"limit[inAppPurchasesV2],omitempty"`
	LimitPromotedPurchases              int      `url:"limit[promotedPurchases],omitempty"`
	LimitSubscriptionGroups             int      `url:"limit[subscriptionGroups],omitempty"`
}

type ListAppsResponse

type ListAppsResponse struct {
	Data []struct {
		Type       string `json:"type"`
		ID         string `json:"id"`
		Attributes struct {
			Name                                   string      `json:"name"`
			BundleID                               string      `json:"bundleId"`
			Sku                                    string      `json:"sku"`
			PrimaryLocale                          string      `json:"primaryLocale"`
			IsOrEverWasMadeForKids                 bool        `json:"isOrEverWasMadeForKids"`
			SubscriptionStatusURL                  interface{} `json:"subscriptionStatusUrl"`
			SubscriptionStatusURLVersion           interface{} `json:"subscriptionStatusUrlVersion"`
			SubscriptionStatusURLForSandbox        interface{} `json:"subscriptionStatusUrlForSandbox"`
			SubscriptionStatusURLVersionForSandbox interface{} `json:"subscriptionStatusUrlVersionForSandbox"`
			AvailableInNewTerritories              bool        `json:"availableInNewTerritories"`
			ContentRightsDeclaration               string      `json:"contentRightsDeclaration"`
		} `json:"attributes"`
		Relationships struct {
			CiProduct struct {
				Links struct {
					Self    string `json:"self"`
					Related string `json:"related"`
				} `json:"links"`
			} `json:"ciProduct"`
			BetaTesters struct {
				Links struct {
					Self string `json:"self"`
				} `json:"links"`
			} `json:"betaTesters"`
			BetaGroups struct {
				Links struct {
					Self    string `json:"self"`
					Related string `json:"related"`
				} `json:"links"`
			} `json:"betaGroups"`
			AppStoreVersions struct {
				Links struct {
					Self    string `json:"self"`
					Related string `json:"related"`
				} `json:"links"`
			} `json:"appStoreVersions"`
			PreReleaseVersions struct {
				Links struct {
					Self    string `json:"self"`
					Related string `json:"related"`
				} `json:"links"`
			} `json:"preReleaseVersions"`
			BetaAppLocalizations struct {
				Links struct {
					Self    string `json:"self"`
					Related string `json:"related"`
				} `json:"links"`
			} `json:"betaAppLocalizations"`
			Builds struct {
				Links struct {
					Self    string `json:"self"`
					Related string `json:"related"`
				} `json:"links"`
			} `json:"builds"`
			BetaLicenseAgreement struct {
				Links struct {
					Self    string `json:"self"`
					Related string `json:"related"`
				} `json:"links"`
			} `json:"betaLicenseAgreement"`
			BetaAppReviewDetail struct {
				Links struct {
					Self    string `json:"self"`
					Related string `json:"related"`
				} `json:"links"`
			} `json:"betaAppReviewDetail"`
			AppInfos struct {
				Links struct {
					Self    string `json:"self"`
					Related string `json:"related"`
				} `json:"links"`
			} `json:"appInfos"`
			AppClips struct {
				Links struct {
					Self    string `json:"self"`
					Related string `json:"related"`
				} `json:"links"`
			} `json:"appClips"`
			AppPricePoints struct {
				Links struct {
					Self    string `json:"self"`
					Related string `json:"related"`
				} `json:"links"`
			} `json:"appPricePoints"`
			PricePoints struct {
				Links struct {
					Self    string `json:"self"`
					Related string `json:"related"`
				} `json:"links"`
			} `json:"pricePoints"`
			EndUserLicenseAgreement struct {
				Links struct {
					Self    string `json:"self"`
					Related string `json:"related"`
				} `json:"links"`
			} `json:"endUserLicenseAgreement"`
			PreOrder struct {
				Links struct {
					Self    string `json:"self"`
					Related string `json:"related"`
				} `json:"links"`
			} `json:"preOrder"`
			Prices struct {
				Links struct {
					Self    string `json:"self"`
					Related string `json:"related"`
				} `json:"links"`
			} `json:"prices"`
			AppPriceSchedule struct {
				Links struct {
					Self    string `json:"self"`
					Related string `json:"related"`
				} `json:"links"`
			} `json:"appPriceSchedule"`
			AvailableTerritories struct {
				Links struct {
					Self    string `json:"self"`
					Related string `json:"related"`
				} `json:"links"`
			} `json:"availableTerritories"`
			AppAvailability struct {
				Links struct {
					Self    string `json:"self"`
					Related string `json:"related"`
				} `json:"links"`
			} `json:"appAvailability"`
			InAppPurchases struct {
				Links struct {
					Self    string `json:"self"`
					Related string `json:"related"`
				} `json:"links"`
			} `json:"inAppPurchases"`
			SubscriptionGroups struct {
				Links struct {
					Self    string `json:"self"`
					Related string `json:"related"`
				} `json:"links"`
			} `json:"subscriptionGroups"`
			GameCenterEnabledVersions struct {
				Links struct {
					Self    string `json:"self"`
					Related string `json:"related"`
				} `json:"links"`
			} `json:"gameCenterEnabledVersions"`
			PerfPowerMetrics struct {
				Links struct {
					Related string `json:"related"`
				} `json:"links"`
			} `json:"perfPowerMetrics"`
			AppCustomProductPages struct {
				Links struct {
					Self    string `json:"self"`
					Related string `json:"related"`
				} `json:"links"`
			} `json:"appCustomProductPages"`
			InAppPurchasesV2 struct {
				Links struct {
					Self    string `json:"self"`
					Related string `json:"related"`
				} `json:"links"`
			} `json:"inAppPurchasesV2"`
			PromotedPurchases struct {
				Links struct {
					Self    string `json:"self"`
					Related string `json:"related"`
				} `json:"links"`
			} `json:"promotedPurchases"`
			AppEvents struct {
				Links struct {
					Self    string `json:"self"`
					Related string `json:"related"`
				} `json:"links"`
			} `json:"appEvents"`
			ReviewSubmissions struct {
				Links struct {
					Self    string `json:"self"`
					Related string `json:"related"`
				} `json:"links"`
			} `json:"reviewSubmissions"`
			SubscriptionGracePeriod struct {
				Links struct {
					Self    string `json:"self"`
					Related string `json:"related"`
				} `json:"links"`
			} `json:"subscriptionGracePeriod"`
			CustomerReviews struct {
				Links struct {
					Self    string `json:"self"`
					Related string `json:"related"`
				} `json:"links"`
			} `json:"customerReviews"`
		} `json:"relationships"`
		Links struct {
			Self string `json:"self"`
		} `json:"links"`
	} `json:"data"`
	Links struct {
		Self string `json:"self"`
	} `json:"links"`
	Meta struct {
		Paging struct {
			Total int `json:"total"`
			Limit int `json:"limit"`
		} `json:"paging"`
	} `json:"meta"`
}

type Token

type Token struct {
	// contains filtered or unexported fields
}

func NewToken

func NewToken(keyID string, issuerID string, lifetime time.Duration, scope []string) *Token

func (*Token) Sign

func (t *Token) Sign(p8key []byte) (string, error)