Books API . familysharing

Instance Methods

close()

Close httplib2 connections.

getFamilyInfo(source=None, x__xgafv=None)

Gets information regarding the family that the user is part of.

share(docId=None, source=None, volumeId=None, x__xgafv=None)

Initiates sharing of the content with the user's family. Empty response indicates success.

unshare(docId=None, source=None, volumeId=None, x__xgafv=None)

Initiates revoking content that has already been shared with the user's family. Empty response indicates success.

Method Details

close()
Close httplib2 connections.
getFamilyInfo(source=None, x__xgafv=None)
Gets information regarding the family that the user is part of.

Args:
  source: string, String to identify the originator of this request.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    {
  "kind": "A String", # Resource type.
  "membership": { # Family membership info of the user that made the request.
    "acquirePermission": "A String", # Restrictions on user buying and acquiring content.
    "ageGroup": "A String", # The age group of the user.
    "allowedMaturityRating": "A String", # The maximum allowed maturity rating for the user.
    "isInFamily": True or False,
    "role": "A String", # The role of the user in the family.
  },
}
share(docId=None, source=None, volumeId=None, x__xgafv=None)
Initiates sharing of the content with the user's family. Empty response indicates success.

Args:
  docId: string, The docid to share.
  source: string, String to identify the originator of this request.
  volumeId: string, The volume to share.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`.
}
unshare(docId=None, source=None, volumeId=None, x__xgafv=None)
Initiates revoking content that has already been shared with the user's family. Empty response indicates success.

Args:
  docId: string, The docid to unshare.
  source: string, String to identify the originator of this request.
  volumeId: string, The volume to unshare.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`.
}