DeleteReaderResponse: Response to deleting a reader of a publication.
type DeleteReaderResponse struct {
// ServerResponse contains the HTTP response code and headers from the server.
googleapi.ServerResponse `json:"-"`
}
Entitlement: A single entitlement for a publication reader
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.
Detail string `json:"detail,omitempty"`
// ExpireTime: Required. Expiration time of the entitlement. Entitlements that
// have expired over 30 days will be purged. Required.
// LINT.IfChange(expire_time) The max expire_time is 398 days from now().
// LINT.ThenChange(//depot/google3/java/com/google/subscribewithgoogle/accountli
// nking/subscriptionlink/service/config/protoconf.pi:max_expiry_age)
ExpireTime string `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"
ProductId string `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.
SubscriptionToken string `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:"-"`
}
func (s *Entitlement) MarshalJSON() ([]byte, error)
type PublicationsReadersDeleteCall struct {
// contains filtered or unexported fields
}
func (c *PublicationsReadersDeleteCall) Context(ctx context.Context) *PublicationsReadersDeleteCall
Context sets the context to be used in this call's Do method.
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 returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (c *PublicationsReadersDeleteCall) Fields(s ...googleapi.Field) *PublicationsReadersDeleteCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.
func (c *PublicationsReadersDeleteCall) Force(force bool) *PublicationsReadersDeleteCall
Force sets the optional parameter "force": If set to true, any entitlements under the reader will also be purged.
func (c *PublicationsReadersDeleteCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
type PublicationsReadersGetCall struct {
// contains filtered or unexported fields
}
func (c *PublicationsReadersGetCall) Context(ctx context.Context) *PublicationsReadersGetCall
Context sets the context to be used in this call's Do method.
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) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (c *PublicationsReadersGetCall) Fields(s ...googleapi.Field) *PublicationsReadersGetCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.
func (c *PublicationsReadersGetCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
func (c *PublicationsReadersGetCall) IfNoneMatch(entityTag string) *PublicationsReadersGetCall
IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.
type PublicationsReadersGetEntitlementsCall struct {
// contains filtered or unexported fields
}
func (c *PublicationsReadersGetEntitlementsCall) Context(ctx context.Context) *PublicationsReadersGetEntitlementsCall
Context sets the context to be used in this call's Do method.
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 at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (c *PublicationsReadersGetEntitlementsCall) Fields(s ...googleapi.Field) *PublicationsReadersGetEntitlementsCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.
func (c *PublicationsReadersGetEntitlementsCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
func (c *PublicationsReadersGetEntitlementsCall) IfNoneMatch(entityTag string) *PublicationsReadersGetEntitlementsCall
IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.
type PublicationsReadersService struct {
// contains filtered or unexported fields
}
func NewPublicationsReadersService(s *Service) *PublicationsReadersService
func (r *PublicationsReadersService) Delete(name string) *PublicationsReadersDeleteCall
Delete: Removes a publication reader, effectively severing the association with a Google user. If `force` is set to true, any entitlements for this reader will also be deleted. (Otherwise, the request will only work if the reader has no entitlements.) - If the reader does not exist, return NOT_FOUND. - Return FAILED_PRECONDITION if the force field is false (or unset) and entitlements are present.
func (r *PublicationsReadersService) Get(name string) *PublicationsReadersGetCall
Get: Gets a reader of a publication. Returns NOT_FOUND if the reader does not exist.
func (r *PublicationsReadersService) GetEntitlements(name string) *PublicationsReadersGetEntitlementsCall
GetEntitlements: Gets the reader entitlements for a publication reader. - Returns PERMISSION_DENIED if the caller does not have access. - Returns NOT_FOUND if the reader does not exist.
func (r *PublicationsReadersService) UpdateEntitlements(name string, readerentitlements *ReaderEntitlements) *PublicationsReadersUpdateEntitlementsCall
UpdateEntitlements: Updates the reader entitlements for a publication reader. The entire reader entitlements will be overwritten by the new reader entitlements in the payload, like a PUT. - Returns PERMISSION_DENIED if the caller does not have access. - Returns NOT_FOUND if the reader does not exist.
- name: Output only. The resource name of the singleton.
type PublicationsReadersUpdateEntitlementsCall struct {
// contains filtered or unexported fields
}
func (c *PublicationsReadersUpdateEntitlementsCall) Context(ctx context.Context) *PublicationsReadersUpdateEntitlementsCall
Context sets the context to be used in this call's Do method.
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 at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (c *PublicationsReadersUpdateEntitlementsCall) Fields(s ...googleapi.Field) *PublicationsReadersUpdateEntitlementsCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.
func (c *PublicationsReadersUpdateEntitlementsCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
func (c *PublicationsReadersUpdateEntitlementsCall) UpdateMask(updateMask string) *PublicationsReadersUpdateEntitlementsCall
UpdateMask sets the optional parameter "updateMask": The list of fields to update. Defaults to all fields.
type PublicationsService struct {
Readers *PublicationsReadersService
// contains filtered or unexported fields
}
func NewPublicationsService(s *Service) *PublicationsService
Reader: A reader of a publication.
type Reader struct {
// CreateTime: Output only. Time the publication reader was created and
// associated with a Google user.
CreateTime string `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.
Name string `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. "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:"-"`
}
func (s *Reader) MarshalJSON() ([]byte, error)
ReaderEntitlements: A singleton containing all of a reader's entitlements for a publication.
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.
Name string `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:"-"`
}
func (s *ReaderEntitlements) MarshalJSON() ([]byte, error)
type Service struct {
BasePath string // API endpoint base URL
UserAgent string // optional additional User-Agent fragment
Publications *PublicationsService
// contains filtered or unexported fields
}
func New(client *http.Client) (*Service, error)
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.
func NewService(ctx context.Context, opts ...option.ClientOption) (*Service, error)
NewService creates a new Service.