readerrevenuesubscriptionlinking
package
This package is not in the latest version of its module.
Details
Validgo.mod file
The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
- Redistributable license
Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
- Tagged version
Modules with tagged versions give importers more predictable builds.
Stable versionWhen a project reaches major version v1 it is considered stable.
- Learn more about best practices
Repository
Links
Open Source Insights
Documentation¶
Overview¶
Package readerrevenuesubscriptionlinking provides access to the Reader Revenue Subscription Linking API.
For product documentation, see:https://developers.google.com/news/subscribe/subscription-linking/overview
Library status¶
These client libraries are officially supported by Google. However, thislibrary is considered complete and is in maintenance mode. This meansthat we will address critical bugs and security issues but will not addany new features.
When possible, we recommend using our newer[Cloud Client Libraries for Go](https://pkg.go.dev/cloud.google.com/go)that are still actively being worked and iterated on.
Creating a client¶
Usage example:
import "google.golang.org/api/readerrevenuesubscriptionlinking/v1"...ctx := context.Background()readerrevenuesubscriptionlinkingService, err := readerrevenuesubscriptionlinking.NewService(ctx)
In this example, Google Application Default Credentials are used forauthentication. For information on how to create and obtain ApplicationDefault Credentials, seehttps://developers.google.com/identity/protocols/application-default-credentials.
Other authentication options¶
To use an API key for authentication (note: some APIs do not support APIkeys), usegoogle.golang.org/api/option.WithAPIKey:
readerrevenuesubscriptionlinkingService, err := readerrevenuesubscriptionlinking.NewService(ctx, option.WithAPIKey("AIza..."))To use an OAuth token (e.g., a user token obtained via a three-legged OAuthflow, usegoogle.golang.org/api/option.WithTokenSource:
config := &oauth2.Config{...}// ...token, err := config.Exchange(ctx, ...)readerrevenuesubscriptionlinkingService, err := readerrevenuesubscriptionlinking.NewService(ctx, option.WithTokenSource(config.TokenSource(ctx, token)))Seegoogle.golang.org/api/option.ClientOption for details on options.
Index¶
- type DeleteReaderResponse
- type Entitlement
- type PublicationsReadersDeleteCall
- func (c *PublicationsReadersDeleteCall) Context(ctx context.Context) *PublicationsReadersDeleteCall
- func (c *PublicationsReadersDeleteCall) Do(opts ...googleapi.CallOption) (*DeleteReaderResponse, error)
- func (c *PublicationsReadersDeleteCall) Fields(s ...googleapi.Field) *PublicationsReadersDeleteCall
- func (c *PublicationsReadersDeleteCall) Force(force bool) *PublicationsReadersDeleteCall
- func (c *PublicationsReadersDeleteCall) Header() http.Header
- type PublicationsReadersGetCall
- func (c *PublicationsReadersGetCall) Context(ctx context.Context) *PublicationsReadersGetCall
- func (c *PublicationsReadersGetCall) Do(opts ...googleapi.CallOption) (*Reader, error)
- func (c *PublicationsReadersGetCall) Fields(s ...googleapi.Field) *PublicationsReadersGetCall
- func (c *PublicationsReadersGetCall) Header() http.Header
- func (c *PublicationsReadersGetCall) IfNoneMatch(entityTag string) *PublicationsReadersGetCall
- type PublicationsReadersGetEntitlementsCall
- func (c *PublicationsReadersGetEntitlementsCall) Context(ctx context.Context) *PublicationsReadersGetEntitlementsCall
- func (c *PublicationsReadersGetEntitlementsCall) Do(opts ...googleapi.CallOption) (*ReaderEntitlements, error)
- func (c *PublicationsReadersGetEntitlementsCall) Fields(s ...googleapi.Field) *PublicationsReadersGetEntitlementsCall
- func (c *PublicationsReadersGetEntitlementsCall) Header() http.Header
- func (c *PublicationsReadersGetEntitlementsCall) IfNoneMatch(entityTag string) *PublicationsReadersGetEntitlementsCall
- type PublicationsReadersService
- func (r *PublicationsReadersService) Delete(name string) *PublicationsReadersDeleteCall
- func (r *PublicationsReadersService) Get(name string) *PublicationsReadersGetCall
- func (r *PublicationsReadersService) GetEntitlements(name string) *PublicationsReadersGetEntitlementsCall
- func (r *PublicationsReadersService) UpdateEntitlements(name string, readerentitlements *ReaderEntitlements) *PublicationsReadersUpdateEntitlementsCall
- type PublicationsReadersUpdateEntitlementsCall
- func (c *PublicationsReadersUpdateEntitlementsCall) Context(ctx context.Context) *PublicationsReadersUpdateEntitlementsCall
- func (c *PublicationsReadersUpdateEntitlementsCall) Do(opts ...googleapi.CallOption) (*ReaderEntitlements, error)
- func (c *PublicationsReadersUpdateEntitlementsCall) Fields(s ...googleapi.Field) *PublicationsReadersUpdateEntitlementsCall
- func (c *PublicationsReadersUpdateEntitlementsCall) Header() http.Header
- func (c *PublicationsReadersUpdateEntitlementsCall) UpdateMask(updateMask string) *PublicationsReadersUpdateEntitlementsCall
- type PublicationsService
- type Reader
- type ReaderEntitlements
- type Service
Constants¶
This section is empty.
Variables¶
This section is empty.
Functions¶
This section is empty.
Types¶
typeDeleteReaderResponse¶
type DeleteReaderResponse struct {// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`}DeleteReaderResponse: Response to deleting a reader of a publication.
typeEntitlement¶
type Entitlement struct {// Detail: The detail field can carry a description of the SKU that corresponds// to what the user has been granted access to. This description, which is// opaque to Google, can be displayed in the Google user subscription console// for users who linked the subscription to a Google Account. Max 80 character// limit.Detailstring `json:"detail,omitempty"`// ExpireTime: Required. Expiration time of the entitlement. Entitlements that// have expired over 30 days will be purged. The max expire_time is 398 days// from now().ExpireTimestring `json:"expireTime,omitempty"`// ProductId: Required. The publication's product ID that the user has access// to. This is the same product ID as can be found in Schema.org markup// (http://schema.org/productID). E.g. "dailybugle.com:basic"ProductIdstring `json:"productId,omitempty"`// SubscriptionToken: A source-specific subscription token. This is an opaque// string that the publisher provides to Google. This token is opaque and has// no meaning to Google.SubscriptionTokenstring `json:"subscriptionToken,omitempty"`// ForceSendFields is a list of field names (e.g. "Detail") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Detail") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}Entitlement: A single entitlement for a publication reader
func (Entitlement)MarshalJSON¶
func (sEntitlement) MarshalJSON() ([]byte,error)
typePublicationsReadersDeleteCall¶
type PublicationsReadersDeleteCall struct {// contains filtered or unexported fields}func (*PublicationsReadersDeleteCall)Context¶
func (c *PublicationsReadersDeleteCall) Context(ctxcontext.Context) *PublicationsReadersDeleteCall
Context sets the context to be used in this call's Do method.
func (*PublicationsReadersDeleteCall)Do¶
func (c *PublicationsReadersDeleteCall) Do(opts ...googleapi.CallOption) (*DeleteReaderResponse,error)
Do executes the "readerrevenuesubscriptionlinking.publications.readers.delete" call.Any non-2xx status code is an error. Response headers are in either*DeleteReaderResponse.ServerResponse.Header or (if a response was returnedat all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified tocheck whether the returned error was because http.StatusNotModified wasreturned.
func (*PublicationsReadersDeleteCall)Fields¶
func (c *PublicationsReadersDeleteCall) Fields(s ...googleapi.Field) *PublicationsReadersDeleteCall
Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.
func (*PublicationsReadersDeleteCall)Force¶
func (c *PublicationsReadersDeleteCall) Force(forcebool) *PublicationsReadersDeleteCall
Force sets the optional parameter "force": If set to true, any entitlementsunder the reader will also be purged.
func (*PublicationsReadersDeleteCall)Header¶
func (c *PublicationsReadersDeleteCall) Header()http.Header
Header returns a http.Header that can be modified by the caller to addheaders to the request.
typePublicationsReadersGetCall¶
type PublicationsReadersGetCall struct {// contains filtered or unexported fields}func (*PublicationsReadersGetCall)Context¶
func (c *PublicationsReadersGetCall) Context(ctxcontext.Context) *PublicationsReadersGetCall
Context sets the context to be used in this call's Do method.
func (*PublicationsReadersGetCall)Do¶
func (c *PublicationsReadersGetCall) Do(opts ...googleapi.CallOption) (*Reader,error)
Do executes the "readerrevenuesubscriptionlinking.publications.readers.get" call.Any non-2xx status code is an error. Response headers are in either*Reader.ServerResponse.Header or (if a response was returned at all) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.
func (*PublicationsReadersGetCall)Fields¶
func (c *PublicationsReadersGetCall) Fields(s ...googleapi.Field) *PublicationsReadersGetCall
Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.
func (*PublicationsReadersGetCall)Header¶
func (c *PublicationsReadersGetCall) Header()http.Header
Header returns a http.Header that can be modified by the caller to addheaders to the request.
func (*PublicationsReadersGetCall)IfNoneMatch¶
func (c *PublicationsReadersGetCall) IfNoneMatch(entityTagstring) *PublicationsReadersGetCall
IfNoneMatch sets an optional parameter which makes the operation fail if theobject's ETag matches the given value. This is useful for getting updatesonly after the object has changed since the last request.
typePublicationsReadersGetEntitlementsCall¶
type PublicationsReadersGetEntitlementsCall struct {// contains filtered or unexported fields}func (*PublicationsReadersGetEntitlementsCall)Context¶
func (c *PublicationsReadersGetEntitlementsCall) Context(ctxcontext.Context) *PublicationsReadersGetEntitlementsCall
Context sets the context to be used in this call's Do method.
func (*PublicationsReadersGetEntitlementsCall)Do¶
func (c *PublicationsReadersGetEntitlementsCall) Do(opts ...googleapi.CallOption) (*ReaderEntitlements,error)
Do executes the "readerrevenuesubscriptionlinking.publications.readers.getEntitlements" call.Any non-2xx status code is an error. Response headers are in either*ReaderEntitlements.ServerResponse.Header or (if a response was returned atall) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified tocheck whether the returned error was because http.StatusNotModified wasreturned.
func (*PublicationsReadersGetEntitlementsCall)Fields¶
func (c *PublicationsReadersGetEntitlementsCall) Fields(s ...googleapi.Field) *PublicationsReadersGetEntitlementsCall
Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.
func (*PublicationsReadersGetEntitlementsCall)Header¶
func (c *PublicationsReadersGetEntitlementsCall) Header()http.Header
Header returns a http.Header that can be modified by the caller to addheaders to the request.
func (*PublicationsReadersGetEntitlementsCall)IfNoneMatch¶
func (c *PublicationsReadersGetEntitlementsCall) IfNoneMatch(entityTagstring) *PublicationsReadersGetEntitlementsCall
IfNoneMatch sets an optional parameter which makes the operation fail if theobject's ETag matches the given value. This is useful for getting updatesonly after the object has changed since the last request.
typePublicationsReadersService¶
type PublicationsReadersService struct {// contains filtered or unexported fields}funcNewPublicationsReadersService¶
func NewPublicationsReadersService(s *Service) *PublicationsReadersService
func (*PublicationsReadersService)Delete¶
func (r *PublicationsReadersService) Delete(namestring) *PublicationsReadersDeleteCall
Delete: Removes a publication reader, effectively severing the associationwith a Google user. If `force` is set to true, any entitlements for thisreader will also be deleted. (Otherwise, the request will only work if thereader has no entitlements.) - If the reader does not exist, returnNOT_FOUND. - Return FAILED_PRECONDITION if the force field is false (orunset) and entitlements are present.
- name: The resource name of the reader. Format:publications/{publication_id}/readers/{ppid}.
func (*PublicationsReadersService)Get¶
func (r *PublicationsReadersService) Get(namestring) *PublicationsReadersGetCall
Get: Gets a reader of a publication. Returns NOT_FOUND if the reader doesnot exist.
- name: The resource name of the reader. Format:publications/{publication_id}/readers/{ppid}.
func (*PublicationsReadersService)GetEntitlements¶
func (r *PublicationsReadersService) GetEntitlements(namestring) *PublicationsReadersGetEntitlementsCall
GetEntitlements: Gets the reader entitlements for a publication reader. -Returns PERMISSION_DENIED if the caller does not have access. - ReturnsNOT_FOUND if the reader does not exist.
- name: The name of the reader entitlements to retrieve. Format:publications/{publication_id}/readers/{reader_id}/entitlements.
func (*PublicationsReadersService)UpdateEntitlements¶
func (r *PublicationsReadersService) UpdateEntitlements(namestring, readerentitlements *ReaderEntitlements) *PublicationsReadersUpdateEntitlementsCall
UpdateEntitlements: Updates the reader entitlements for a publicationreader. The entire reader entitlements will be overwritten by the new readerentitlements in the payload, like a PUT. - Returns PERMISSION_DENIED if thecaller does not have access. - Returns NOT_FOUND if the reader does notexist.
- name: Output only. The resource name of the singleton.
typePublicationsReadersUpdateEntitlementsCall¶
type PublicationsReadersUpdateEntitlementsCall struct {// contains filtered or unexported fields}func (*PublicationsReadersUpdateEntitlementsCall)Context¶
func (c *PublicationsReadersUpdateEntitlementsCall) Context(ctxcontext.Context) *PublicationsReadersUpdateEntitlementsCall
Context sets the context to be used in this call's Do method.
func (*PublicationsReadersUpdateEntitlementsCall)Do¶
func (c *PublicationsReadersUpdateEntitlementsCall) Do(opts ...googleapi.CallOption) (*ReaderEntitlements,error)
Do executes the "readerrevenuesubscriptionlinking.publications.readers.updateEntitlements" call.Any non-2xx status code is an error. Response headers are in either*ReaderEntitlements.ServerResponse.Header or (if a response was returned atall) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified tocheck whether the returned error was because http.StatusNotModified wasreturned.
func (*PublicationsReadersUpdateEntitlementsCall)Fields¶
func (c *PublicationsReadersUpdateEntitlementsCall) Fields(s ...googleapi.Field) *PublicationsReadersUpdateEntitlementsCall
Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.
func (*PublicationsReadersUpdateEntitlementsCall)Header¶
func (c *PublicationsReadersUpdateEntitlementsCall) Header()http.Header
Header returns a http.Header that can be modified by the caller to addheaders to the request.
func (*PublicationsReadersUpdateEntitlementsCall)UpdateMask¶
func (c *PublicationsReadersUpdateEntitlementsCall) UpdateMask(updateMaskstring) *PublicationsReadersUpdateEntitlementsCall
UpdateMask sets the optional parameter "updateMask": The list of fields toupdate. Defaults to all fields.
typePublicationsService¶
type PublicationsService struct {Readers *PublicationsReadersService// contains filtered or unexported fields}funcNewPublicationsService¶
func NewPublicationsService(s *Service) *PublicationsService
typeReader¶
type Reader struct {// CreateTime: Output only. Time the publication reader was created and// associated with a Google user.CreateTimestring `json:"createTime,omitempty"`// Name: Output only. The resource name of the reader. The last part of ppid in// the resource name is the publisher provided id.Namestring `json:"name,omitempty"`// OriginatingPublicationId: Output only. The SwG publication id that the// reader's subscription linking was originating from.OriginatingPublicationIdstring `json:"originatingPublicationId,omitempty"`// Ppid: Output only. The publisher provided id of the reader.Ppidstring `json:"ppid,omitempty"`// PublicationId: Output only. The SwG publication id that the reader has// linked their subscription to.PublicationIdstring `json:"publicationId,omitempty"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "CreateTime") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "CreateTime") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}Reader: A reader of a publication.
func (Reader)MarshalJSON¶
typeReaderEntitlements¶
type ReaderEntitlements struct {// Entitlements: All of the entitlements for a publication reader.Entitlements []*Entitlement `json:"entitlements,omitempty"`// Name: Output only. The resource name of the singleton.Namestring `json:"name,omitempty"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "Entitlements") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Entitlements") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}ReaderEntitlements: A singleton containing all of a reader's entitlementsfor a publication.
func (ReaderEntitlements)MarshalJSON¶
func (sReaderEntitlements) MarshalJSON() ([]byte,error)
typeService¶
type Service struct {BasePathstring// API endpoint base URLUserAgentstring// optional additional User-Agent fragmentPublications *PublicationsService// contains filtered or unexported fields} funcNewdeprecated
New creates a new Service. It uses the provided http.Client for requests.
Deprecated: please use NewService instead.To provide a custom HTTP client, use option.WithHTTPClient.If you are using google.golang.org/api/googleapis/transport.APIKey, use option.WithAPIKey with NewService instead.
funcNewService¶
NewService creates a new Service.
Source Files