Books API . familysharing

Instance Methods

getFamilyInfo(source=None)

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

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

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

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

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

Method Details

getFamilyInfo(source=None)
Gets information regarding the family that the user is part of.

Args:
  source: string, String to identify the originator of this request.

Returns:
  An object of the form:

    {
    "kind": "books#familyInfo", # Resource type.
    "membership": { # Family membership info of the user that made the request.
      "acquirePermission": "A String", # Restrictions on user buying and acquiring content.
      "allowedMaturityRating": "A String", # The maximum allowed maturity rating for the user.
      "role": "A String", # The role of the user in the family.
      "ageGroup": "A String", # The age group of the user.
      "isInFamily": True or False,
    },
  }
share(docId=None, source=None, volumeId=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.
unshare(docId=None, source=None, volumeId=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.