Blame - docs/dyn/plus_v1.people.html - platform/external/python/google-api-python-client

2020-05-20 12:08:20 -0700

[diff] [blame]

81

<code><a href="#list">list(userId, collection, maxResults=None, orderBy=None, pageToken=None)</a></code></p>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

82

<p class="firstline">List all of the people in the specified collection.</p>

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

83

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

84

<code><a href="#listByActivity">listByActivity(activityId, collection, maxResults=None, pageToken=None)</a></code></p>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

85

<p class="firstline">Shut down. See https://developers.google.com/+/api-shutdown for more details.</p>

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

86

87

<code><a href="#listByActivity_next">listByActivity_next(previous_request, previous_response)</a></code></p>

88

<p class="firstline">Retrieves the next page of results.</p>

89

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

90

<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>

91

<p class="firstline">Retrieves the next page of results.</p>

92

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

93

<code><a href="#search">search(query, language=None, maxResults=None, pageToken=None)</a></code></p>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

94

<p class="firstline">Shut down. See https://developers.google.com/+/api-shutdown for more details.</p>

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

95

96

<code><a href="#search_next">search_next(previous_request, previous_response)</a></code></p>

97

<p class="firstline">Retrieves the next page of results.</p>

98

<h3>Method Details</h3>

99

100

<code class="details" id="get">get(userId)</code>

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

101

<pre>Get a person's profile. If your app uses scope https://www.googleapis.com/auth/plus.login, this method is guaranteed to return ageRange and language.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

102

103

Args:

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

104

userId: string, The ID of the person to get the profile for. The special value "me" can be used to indicate the authenticated user. (required)

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

105

106

Returns:

107

An object of the form:

108

109

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

110

"aboutMe": "A String", # A short biography for this person.

111

"ageRange": { # The age range of the person. Valid ranges are 17 or younger, 18 to 20, and 21 or older. Age is determined from the user's birthday using Western age reckoning.

112

"max": 42, # The age range's upper bound, if any. Possible values include, but are not limited to, the following:

113

# - "17" - for age 17

114

# - "20" - for age 20

115

"min": 42, # The age range's lower bound, if any. Possible values include, but are not limited to, the following:

116

# - "21" - for age 21

117

# - "18" - for age 18

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

118

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

119

"birthday": "A String", # The person's date of birth, represented as YYYY-MM-DD.

120

"braggingRights": "A String", # The "bragging rights" line of this person.

121

"circledByCount": 42, # For followers who are visible, the number of people who have added this person or page to a circle.

122

"cover": { # The cover photo content.

123

"coverInfo": { # Extra information about the cover photo.

124

"leftImageOffset": 42, # The difference between the left position of the cover image and the actual displayed cover image. Only valid for banner layout.

125

"topImageOffset": 42, # The difference between the top position of the cover image and the actual displayed cover image. Only valid for banner layout.

126

},

127

"coverPhoto": { # The person's primary cover image.

128

"height": 42, # The height of the image.

129

"url": "A String", # The URL of the image.

130

"width": 42, # The width of the image.

131

},

132

"layout": "A String", # The layout of the cover art. Possible values include, but are not limited to, the following values:

133

# - "banner" - One large image banner.

134

},

135

"currentLocation": "A String", # (this field is not currently used)

136

"displayName": "A String", # The name of this person, which is suitable for display.

137

"domain": "A String", # The hosted domain name for the user's Google Apps account. For instance, example.com. The plus.profile.emails.read or email scope is needed to get this domain name.

138

"emails": [ # A list of email addresses that this person has, including their Google account email address, and the public verified email addresses on their Google+ profile. The plus.profile.emails.read scope is needed to retrieve these email addresses, or the email scope can be used to retrieve just the Google account email address.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

139

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

140

"type": "A String", # The type of address. Possible values include, but are not limited to, the following values:

141

# - "account" - Google account email address.

142

# - "home" - Home email address.

143

# - "work" - Work email address.

144

# - "other" - Other.

145

"value": "A String", # The email address.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

146

},

147

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

148

"etag": "A String", # ETag of this response for caching purposes.

149

"gender": "A String", # The person's gender. Possible values include, but are not limited to, the following values:

150

# - "male" - Male gender.

151

# - "female" - Female gender.

152

# - "other" - Other.

153

"id": "A String", # The ID of this person.

154

"image": { # The representation of the person's profile photo.

155

"isDefault": True or False, # Whether the person's profile photo is the default one

156

"url": "A String", # The URL of the person's profile photo. To resize the image and crop it to a square, append the query string ?sz=x, where x is the dimension in pixels of each side.

157

},

158

"isPlusUser": True or False, # Whether this user has signed up for Google+.

159

"kind": "plus#person", # Identifies this resource as a person. Value: "plus#person".

160

"language": "A String", # The user's preferred language for rendering.

161

"name": { # An object representation of the individual components of a person's name.

162

"familyName": "A String", # The family name (last name) of this person.

163

"formatted": "A String", # The full name of this person, including middle names, suffixes, etc.

164

"givenName": "A String", # The given name (first name) of this person.

165

"honorificPrefix": "A String", # The honorific prefixes (such as "Dr." or "Mrs.") for this person.

166

"honorificSuffix": "A String", # The honorific suffixes (such as "Jr.") for this person.

167

"middleName": "A String", # The middle name of this person.

168

},

169

"nickname": "A String", # The nickname of this person.

170

"objectType": "A String", # Type of person within Google+. Possible values include, but are not limited to, the following values:

171

# - "person" - represents an actual person.

172

# - "page" - represents a page.

173

"occupation": "A String", # The occupation of this person.

174

"organizations": [ # A list of current or past organizations with which this person is associated.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

175

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

176

"department": "A String", # The department within the organization. Deprecated.

177

"description": "A String", # A short description of the person's role in this organization. Deprecated.

178

"endDate": "A String", # The date that the person left this organization.

179

"location": "A String", # The location of this organization. Deprecated.

180

"name": "A String", # The name of the organization.

181

"primary": True or False, # If "true", indicates this organization is the person's primary one, which is typically interpreted as the current one.

182

"startDate": "A String", # The date that the person joined this organization.

183

"title": "A String", # The person's job title or role within the organization.

184

"type": "A String", # The type of organization. Possible values include, but are not limited to, the following values:

185

# - "work" - Work.

186

# - "school" - School.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

187

},

188

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

189

"placesLived": [ # A list of places where this person has lived.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

190

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

191

"primary": True or False, # If "true", this place of residence is this person's primary residence.

192

"value": "A String", # A place where this person has lived. For example: "Seattle, WA", "Near Toronto".

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

193

},

194

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

195

"plusOneCount": 42, # If a Google+ Page, the number of people who have +1'd this page.

196

"relationshipStatus": "A String", # The person's relationship status. Possible values include, but are not limited to, the following values:

197

# - "single" - Person is single.

198

# - "in_a_relationship" - Person is in a relationship.

199

# - "engaged" - Person is engaged.

200

# - "married" - Person is married.

201

# - "its_complicated" - The relationship is complicated.

202

# - "open_relationship" - Person is in an open relationship.

203

# - "widowed" - Person is widowed.

204

# - "in_domestic_partnership" - Person is in a domestic partnership.

205

# - "in_civil_union" - Person is in a civil union.

206

"skills": "A String", # The person's skills.

207

"tagline": "A String", # The brief description (tagline) of this person.

208

"url": "A String", # The URL of this person's profile.

209

"urls": [ # A list of URLs for this person.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

210

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

211

"label": "A String", # The label of the URL.

212

"type": "A String", # The type of URL. Possible values include, but are not limited to, the following values:

213

# - "otherProfile" - URL for another profile.

214

# - "contributor" - URL to a site for which this person is a contributor.

215

# - "website" - URL for this Google+ Page's primary website.

216

# - "other" - Other URL.

217

"value": "A String", # The URL value.

Jon Wayne Parrott

dc6c1ef

2016-10-14 11:04:30 -0700

[diff] [blame]

218

},

Sai Cheemalapati

ea3a5e1

2016-10-12 14:05:53 -0700

[diff] [blame]

219

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

220

"verified": True or False, # Whether the person or Google+ Page has been verified.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

}</pre>

</div>

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

225

<code class="details" id="list">list(userId, collection, maxResults=None, orderBy=None, pageToken=None)</code>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

226

<pre>List all of the people in the specified collection.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

227

228

Args:

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

229

userId: string, Get the collection of people for the person identified. Use "me" to indicate the authenticated user. (required)

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

230

collection: string, The collection of people to list. (required)

231

Allowed values

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

232

connected - The list of visible people in the authenticated user's circles who also use the requesting app. This list is limited to users who made their app activities visible to the authenticated user.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

233

visible - The list of people who this user has added to one or more circles, limited to the circles visible to the requesting application.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

234

maxResults: integer, The maximum number of people to include in the response, which is used for paging. For any response, the actual number returned might be less than the specified maxResults.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

235

orderBy: string, The order to return people in.

236

Allowed values

237

alphabetical - Order the people by their display name.

238

best - Order people based on the relevence to the viewer.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

239

pageToken: string, The continuation token, which is used to page through large result sets. To get the next page of results, set this parameter to the value of "nextPageToken" from the previous response.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

240

241

Returns:

242

An object of the form:

243

244

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

245

"etag": "A String", # ETag of this response for caching purposes.

246

"items": [ # The people in this page of results. Each item includes the id, displayName, image, and url for the person. To retrieve additional profile data, see the people.get method.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

247

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

248

"aboutMe": "A String", # A short biography for this person.

249

"ageRange": { # The age range of the person. Valid ranges are 17 or younger, 18 to 20, and 21 or older. Age is determined from the user's birthday using Western age reckoning.

250

"max": 42, # The age range's upper bound, if any. Possible values include, but are not limited to, the following:

251

# - "17" - for age 17

252

# - "20" - for age 20

253

"min": 42, # The age range's lower bound, if any. Possible values include, but are not limited to, the following:

254

# - "21" - for age 21

255

# - "18" - for age 18

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

256

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

257

"birthday": "A String", # The person's date of birth, represented as YYYY-MM-DD.

258

"braggingRights": "A String", # The "bragging rights" line of this person.

259

"circledByCount": 42, # For followers who are visible, the number of people who have added this person or page to a circle.

260

"cover": { # The cover photo content.

261

"coverInfo": { # Extra information about the cover photo.

262

"leftImageOffset": 42, # The difference between the left position of the cover image and the actual displayed cover image. Only valid for banner layout.

263

"topImageOffset": 42, # The difference between the top position of the cover image and the actual displayed cover image. Only valid for banner layout.

264

},

265

"coverPhoto": { # The person's primary cover image.

266

"height": 42, # The height of the image.

267

"url": "A String", # The URL of the image.

268

"width": 42, # The width of the image.

269

},

270

"layout": "A String", # The layout of the cover art. Possible values include, but are not limited to, the following values:

271

# - "banner" - One large image banner.

272

},

273

"currentLocation": "A String", # (this field is not currently used)

274

"displayName": "A String", # The name of this person, which is suitable for display.

275

"domain": "A String", # The hosted domain name for the user's Google Apps account. For instance, example.com. The plus.profile.emails.read or email scope is needed to get this domain name.

276

"emails": [ # A list of email addresses that this person has, including their Google account email address, and the public verified email addresses on their Google+ profile. The plus.profile.emails.read scope is needed to retrieve these email addresses, or the email scope can be used to retrieve just the Google account email address.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

277

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

278

"type": "A String", # The type of address. Possible values include, but are not limited to, the following values:

279

# - "account" - Google account email address.

280

# - "home" - Home email address.

281

# - "work" - Work email address.

282

# - "other" - Other.

283

"value": "A String", # The email address.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

284

},

285

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

286

"etag": "A String", # ETag of this response for caching purposes.

287

"gender": "A String", # The person's gender. Possible values include, but are not limited to, the following values:

288

# - "male" - Male gender.

289

# - "female" - Female gender.

290

# - "other" - Other.

291

"id": "A String", # The ID of this person.

292

"image": { # The representation of the person's profile photo.

293

"isDefault": True or False, # Whether the person's profile photo is the default one

294

"url": "A String", # The URL of the person's profile photo. To resize the image and crop it to a square, append the query string ?sz=x, where x is the dimension in pixels of each side.

295

},

296

"isPlusUser": True or False, # Whether this user has signed up for Google+.

297

"kind": "plus#person", # Identifies this resource as a person. Value: "plus#person".

298

"language": "A String", # The user's preferred language for rendering.

299

"name": { # An object representation of the individual components of a person's name.

300

"familyName": "A String", # The family name (last name) of this person.

301

"formatted": "A String", # The full name of this person, including middle names, suffixes, etc.

302

"givenName": "A String", # The given name (first name) of this person.

303

"honorificPrefix": "A String", # The honorific prefixes (such as "Dr." or "Mrs.") for this person.

304

"honorificSuffix": "A String", # The honorific suffixes (such as "Jr.") for this person.

305

"middleName": "A String", # The middle name of this person.

306

},

307

"nickname": "A String", # The nickname of this person.

308

"objectType": "A String", # Type of person within Google+. Possible values include, but are not limited to, the following values:

309

# - "person" - represents an actual person.

310

# - "page" - represents a page.

311

"occupation": "A String", # The occupation of this person.

312

"organizations": [ # A list of current or past organizations with which this person is associated.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

313

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

314

"department": "A String", # The department within the organization. Deprecated.

315

"description": "A String", # A short description of the person's role in this organization. Deprecated.

316

"endDate": "A String", # The date that the person left this organization.

317

"location": "A String", # The location of this organization. Deprecated.

318

"name": "A String", # The name of the organization.

319

"primary": True or False, # If "true", indicates this organization is the person's primary one, which is typically interpreted as the current one.

320

"startDate": "A String", # The date that the person joined this organization.

321

"title": "A String", # The person's job title or role within the organization.

322

"type": "A String", # The type of organization. Possible values include, but are not limited to, the following values:

323

# - "work" - Work.

324

# - "school" - School.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

325

},

326

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

327

"placesLived": [ # A list of places where this person has lived.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

328

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

329

"primary": True or False, # If "true", this place of residence is this person's primary residence.

330

"value": "A String", # A place where this person has lived. For example: "Seattle, WA", "Near Toronto".

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

331

},

332

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

333

"plusOneCount": 42, # If a Google+ Page, the number of people who have +1'd this page.

334

"relationshipStatus": "A String", # The person's relationship status. Possible values include, but are not limited to, the following values:

335

# - "single" - Person is single.

336

# - "in_a_relationship" - Person is in a relationship.

337

# - "engaged" - Person is engaged.

338

# - "married" - Person is married.

339

# - "its_complicated" - The relationship is complicated.

340

# - "open_relationship" - Person is in an open relationship.

341

# - "widowed" - Person is widowed.

342

# - "in_domestic_partnership" - Person is in a domestic partnership.

343

# - "in_civil_union" - Person is in a civil union.

344

"skills": "A String", # The person's skills.

345

"tagline": "A String", # The brief description (tagline) of this person.

346

"url": "A String", # The URL of this person's profile.

347

"urls": [ # A list of URLs for this person.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

348

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

349

"label": "A String", # The label of the URL.

350

"type": "A String", # The type of URL. Possible values include, but are not limited to, the following values:

351

# - "otherProfile" - URL for another profile.

352

# - "contributor" - URL to a site for which this person is a contributor.

353

# - "website" - URL for this Google+ Page's primary website.

354

# - "other" - Other URL.

355

"value": "A String", # The URL value.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

356

},

357

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

358

"verified": True or False, # Whether the person or Google+ Page has been verified.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

359

},

360

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

361

"kind": "plus#peopleFeed", # Identifies this resource as a collection of people. Value: "plus#peopleFeed".

362

"nextPageToken": "A String", # The continuation token, which is used to page through large result sets. Provide this value in a subsequent request to return the next page of results.

363

"selfLink": "A String", # Link to this resource.

364

"title": "A String", # The title of this collection of people.

365

"totalItems": 42, # The total number of people available in this list. The number of people in a response might be smaller due to paging. This might not be set for all collections.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

}</pre>

</div>

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

370

<code class="details" id="listByActivity">listByActivity(activityId, collection, maxResults=None, pageToken=None)</code>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

371

<pre>Shut down. See https://developers.google.com/+/api-shutdown for more details.

372

373

Args:

374

activityId: string, The ID of the activity to get the list of people for. (required)

375

collection: string, The collection of people to list. (required)

376

Allowed values

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

377

plusoners - List all people who have +1'd this activity.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

378

resharers - List all people who have reshared this activity.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

379

maxResults: integer, The maximum number of people to include in the response, which is used for paging. For any response, the actual number returned might be less than the specified maxResults.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

380

pageToken: string, The continuation token, which is used to page through large result sets. To get the next page of results, set this parameter to the value of "nextPageToken" from the previous response.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

381

382

Returns:

383

An object of the form:

384

385

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

386

"etag": "A String", # ETag of this response for caching purposes.

387

"items": [ # The people in this page of results. Each item includes the id, displayName, image, and url for the person. To retrieve additional profile data, see the people.get method.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

388

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

389

"aboutMe": "A String", # A short biography for this person.

390

"ageRange": { # The age range of the person. Valid ranges are 17 or younger, 18 to 20, and 21 or older. Age is determined from the user's birthday using Western age reckoning.

391

"max": 42, # The age range's upper bound, if any. Possible values include, but are not limited to, the following:

392

# - "17" - for age 17

393

# - "20" - for age 20

394

"min": 42, # The age range's lower bound, if any. Possible values include, but are not limited to, the following:

395

# - "21" - for age 21

396

# - "18" - for age 18

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

397

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

398

"birthday": "A String", # The person's date of birth, represented as YYYY-MM-DD.

399

"braggingRights": "A String", # The "bragging rights" line of this person.

400

"circledByCount": 42, # For followers who are visible, the number of people who have added this person or page to a circle.

401

"cover": { # The cover photo content.

402

"coverInfo": { # Extra information about the cover photo.

403

"leftImageOffset": 42, # The difference between the left position of the cover image and the actual displayed cover image. Only valid for banner layout.

404

"topImageOffset": 42, # The difference between the top position of the cover image and the actual displayed cover image. Only valid for banner layout.

405

},

406

"coverPhoto": { # The person's primary cover image.

407

"height": 42, # The height of the image.

408

"url": "A String", # The URL of the image.

409

"width": 42, # The width of the image.

410

},

411

"layout": "A String", # The layout of the cover art. Possible values include, but are not limited to, the following values:

412

# - "banner" - One large image banner.

413

},

414

"currentLocation": "A String", # (this field is not currently used)

415

"displayName": "A String", # The name of this person, which is suitable for display.

416

"domain": "A String", # The hosted domain name for the user's Google Apps account. For instance, example.com. The plus.profile.emails.read or email scope is needed to get this domain name.

417

"emails": [ # A list of email addresses that this person has, including their Google account email address, and the public verified email addresses on their Google+ profile. The plus.profile.emails.read scope is needed to retrieve these email addresses, or the email scope can be used to retrieve just the Google account email address.

Sai Cheemalapati

ea3a5e1

2016-10-12 14:05:53 -0700

[diff] [blame]

418

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

419

"type": "A String", # The type of address. Possible values include, but are not limited to, the following values:

420

# - "account" - Google account email address.

421

# - "home" - Home email address.

422

# - "work" - Work email address.

423

# - "other" - Other.

424

"value": "A String", # The email address.

Sai Cheemalapati

ea3a5e1

2016-10-12 14:05:53 -0700

[diff] [blame]

425

},

426

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

427

"etag": "A String", # ETag of this response for caching purposes.

428

"gender": "A String", # The person's gender. Possible values include, but are not limited to, the following values:

429

# - "male" - Male gender.

430

# - "female" - Female gender.

431

# - "other" - Other.

432

"id": "A String", # The ID of this person.

433

"image": { # The representation of the person's profile photo.

434

"isDefault": True or False, # Whether the person's profile photo is the default one

435

"url": "A String", # The URL of the person's profile photo. To resize the image and crop it to a square, append the query string ?sz=x, where x is the dimension in pixels of each side.

436

},

437

"isPlusUser": True or False, # Whether this user has signed up for Google+.

438

"kind": "plus#person", # Identifies this resource as a person. Value: "plus#person".

439

"language": "A String", # The user's preferred language for rendering.

440

"name": { # An object representation of the individual components of a person's name.

441

"familyName": "A String", # The family name (last name) of this person.

442

"formatted": "A String", # The full name of this person, including middle names, suffixes, etc.

443

"givenName": "A String", # The given name (first name) of this person.

444

"honorificPrefix": "A String", # The honorific prefixes (such as "Dr." or "Mrs.") for this person.

445

"honorificSuffix": "A String", # The honorific suffixes (such as "Jr.") for this person.

446

"middleName": "A String", # The middle name of this person.

447

},

448

"nickname": "A String", # The nickname of this person.

449

"objectType": "A String", # Type of person within Google+. Possible values include, but are not limited to, the following values:

450

# - "person" - represents an actual person.

451

# - "page" - represents a page.

452

"occupation": "A String", # The occupation of this person.

453

"organizations": [ # A list of current or past organizations with which this person is associated.

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

454

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

455

"department": "A String", # The department within the organization. Deprecated.

456

"description": "A String", # A short description of the person's role in this organization. Deprecated.

457

"endDate": "A String", # The date that the person left this organization.

458

"location": "A String", # The location of this organization. Deprecated.

459

"name": "A String", # The name of the organization.

460

"primary": True or False, # If "true", indicates this organization is the person's primary one, which is typically interpreted as the current one.

461

"startDate": "A String", # The date that the person joined this organization.

462

"title": "A String", # The person's job title or role within the organization.

463

"type": "A String", # The type of organization. Possible values include, but are not limited to, the following values:

464

# - "work" - Work.

465

# - "school" - School.

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

466

},

467

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

468

"placesLived": [ # A list of places where this person has lived.

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

469

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

470

"primary": True or False, # If "true", this place of residence is this person's primary residence.

471

"value": "A String", # A place where this person has lived. For example: "Seattle, WA", "Near Toronto".

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

472

},

473

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

474

"plusOneCount": 42, # If a Google+ Page, the number of people who have +1'd this page.

475

"relationshipStatus": "A String", # The person's relationship status. Possible values include, but are not limited to, the following values:

476

# - "single" - Person is single.

477

# - "in_a_relationship" - Person is in a relationship.

478

# - "engaged" - Person is engaged.

479

# - "married" - Person is married.

480

# - "its_complicated" - The relationship is complicated.

481

# - "open_relationship" - Person is in an open relationship.

482

# - "widowed" - Person is widowed.

483

# - "in_domestic_partnership" - Person is in a domestic partnership.

484

# - "in_civil_union" - Person is in a civil union.

485

"skills": "A String", # The person's skills.

486

"tagline": "A String", # The brief description (tagline) of this person.

487

"url": "A String", # The URL of this person's profile.

488

"urls": [ # A list of URLs for this person.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

489

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

490

"label": "A String", # The label of the URL.

491

"type": "A String", # The type of URL. Possible values include, but are not limited to, the following values:

492

# - "otherProfile" - URL for another profile.

493

# - "contributor" - URL to a site for which this person is a contributor.

494

# - "website" - URL for this Google+ Page's primary website.

495

# - "other" - Other URL.

496

"value": "A String", # The URL value.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

497

},

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

498

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

499

"verified": True or False, # Whether the person or Google+ Page has been verified.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

500

},

501

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

502

"kind": "plus#peopleFeed", # Identifies this resource as a collection of people. Value: "plus#peopleFeed".

503

"nextPageToken": "A String", # The continuation token, which is used to page through large result sets. Provide this value in a subsequent request to return the next page of results.

504

"selfLink": "A String", # Link to this resource.

505

"title": "A String", # The title of this collection of people.

506

"totalItems": 42, # The total number of people available in this list. The number of people in a response might be smaller due to paging. This might not be set for all collections.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

}</pre>

</div>

<code class="details" id="listByActivity_next">listByActivity_next(previous_request, previous_response)</code>

512

<pre>Retrieves the next page of results.

513

514

Args:

515

previous_request: The request for the previous page. (required)

516

previous_response: The response from the request for the previous page. (required)

517

518

Returns:

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

519

A request object that you can call 'execute()' on to request the next

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

520

page. Returns None if there are no more items in the collection.

</pre>

</div>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

525

<code class="details" id="list_next">list_next(previous_request, previous_response)</code>

526

<pre>Retrieves the next page of results.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

527

528

Args:

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

529

previous_request: The request for the previous page. (required)

530

previous_response: The response from the request for the previous page. (required)

531

532

Returns:

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

533

A request object that you can call 'execute()' on to request the next

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

534

page. Returns None if there are no more items in the collection.

</pre>

</div>

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

539

<code class="details" id="search">search(query, language=None, maxResults=None, pageToken=None)</code>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

540

<pre>Shut down. See https://developers.google.com/+/api-shutdown for more details.

541

542

Args:

543

query: string, Specify a query string for full text search of public text in all profiles. (required)

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

544

language: string, Specify the preferred language to search with. See search language codes for available values.

545

maxResults: integer, The maximum number of people to include in the response, which is used for paging. For any response, the actual number returned might be less than the specified maxResults.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

546

pageToken: string, The continuation token, which is used to page through large result sets. To get the next page of results, set this parameter to the value of "nextPageToken" from the previous response. This token can be of any length.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

547

548

Returns:

549

An object of the form:

550

551

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

552

"etag": "A String", # ETag of this response for caching purposes.

553

"items": [ # The people in this page of results. Each item includes the id, displayName, image, and url for the person. To retrieve additional profile data, see the people.get method.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

554

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

555

"aboutMe": "A String", # A short biography for this person.

556

"ageRange": { # The age range of the person. Valid ranges are 17 or younger, 18 to 20, and 21 or older. Age is determined from the user's birthday using Western age reckoning.

557

"max": 42, # The age range's upper bound, if any. Possible values include, but are not limited to, the following:

558

# - "17" - for age 17

559

# - "20" - for age 20

560

"min": 42, # The age range's lower bound, if any. Possible values include, but are not limited to, the following:

561

# - "21" - for age 21

562

# - "18" - for age 18

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

563

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

564

"birthday": "A String", # The person's date of birth, represented as YYYY-MM-DD.

565

"braggingRights": "A String", # The "bragging rights" line of this person.

566

"circledByCount": 42, # For followers who are visible, the number of people who have added this person or page to a circle.

567

"cover": { # The cover photo content.

568

"coverInfo": { # Extra information about the cover photo.

569

"leftImageOffset": 42, # The difference between the left position of the cover image and the actual displayed cover image. Only valid for banner layout.

570

"topImageOffset": 42, # The difference between the top position of the cover image and the actual displayed cover image. Only valid for banner layout.

571

},

572

"coverPhoto": { # The person's primary cover image.

573

"height": 42, # The height of the image.

574

"url": "A String", # The URL of the image.

575

"width": 42, # The width of the image.

576

},

577

"layout": "A String", # The layout of the cover art. Possible values include, but are not limited to, the following values:

578

# - "banner" - One large image banner.

579

},

580

"currentLocation": "A String", # (this field is not currently used)

581

"displayName": "A String", # The name of this person, which is suitable for display.

582

"domain": "A String", # The hosted domain name for the user's Google Apps account. For instance, example.com. The plus.profile.emails.read or email scope is needed to get this domain name.

583

"emails": [ # A list of email addresses that this person has, including their Google account email address, and the public verified email addresses on their Google+ profile. The plus.profile.emails.read scope is needed to retrieve these email addresses, or the email scope can be used to retrieve just the Google account email address.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

584

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

585

"type": "A String", # The type of address. Possible values include, but are not limited to, the following values:

586

# - "account" - Google account email address.

587

# - "home" - Home email address.

588

# - "work" - Work email address.

589

# - "other" - Other.

590

"value": "A String", # The email address.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

591

},

592

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

593

"etag": "A String", # ETag of this response for caching purposes.

594

"gender": "A String", # The person's gender. Possible values include, but are not limited to, the following values:

595

# - "male" - Male gender.

596

# - "female" - Female gender.

597

# - "other" - Other.

598

"id": "A String", # The ID of this person.

599

"image": { # The representation of the person's profile photo.

600

"isDefault": True or False, # Whether the person's profile photo is the default one

601

"url": "A String", # The URL of the person's profile photo. To resize the image and crop it to a square, append the query string ?sz=x, where x is the dimension in pixels of each side.

602

},

603

"isPlusUser": True or False, # Whether this user has signed up for Google+.

604

"kind": "plus#person", # Identifies this resource as a person. Value: "plus#person".

605

"language": "A String", # The user's preferred language for rendering.

606

"name": { # An object representation of the individual components of a person's name.

607

"familyName": "A String", # The family name (last name) of this person.

608

"formatted": "A String", # The full name of this person, including middle names, suffixes, etc.

609

"givenName": "A String", # The given name (first name) of this person.

610

"honorificPrefix": "A String", # The honorific prefixes (such as "Dr." or "Mrs.") for this person.

611

"honorificSuffix": "A String", # The honorific suffixes (such as "Jr.") for this person.

612

"middleName": "A String", # The middle name of this person.

613

},

614

"nickname": "A String", # The nickname of this person.

615

"objectType": "A String", # Type of person within Google+. Possible values include, but are not limited to, the following values:

616

# - "person" - represents an actual person.

617

# - "page" - represents a page.

618

"occupation": "A String", # The occupation of this person.

619

"organizations": [ # A list of current or past organizations with which this person is associated.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

620

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

621

"department": "A String", # The department within the organization. Deprecated.

622

"description": "A String", # A short description of the person's role in this organization. Deprecated.

623

"endDate": "A String", # The date that the person left this organization.

624

"location": "A String", # The location of this organization. Deprecated.

625

"name": "A String", # The name of the organization.

626

"primary": True or False, # If "true", indicates this organization is the person's primary one, which is typically interpreted as the current one.

627

"startDate": "A String", # The date that the person joined this organization.

628

"title": "A String", # The person's job title or role within the organization.

629

"type": "A String", # The type of organization. Possible values include, but are not limited to, the following values:

630

# - "work" - Work.

631

# - "school" - School.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

632

},

633

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

634

"placesLived": [ # A list of places where this person has lived.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

635

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

636

"primary": True or False, # If "true", this place of residence is this person's primary residence.

637

"value": "A String", # A place where this person has lived. For example: "Seattle, WA", "Near Toronto".

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

638

},

639

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

640

"plusOneCount": 42, # If a Google+ Page, the number of people who have +1'd this page.

641

"relationshipStatus": "A String", # The person's relationship status. Possible values include, but are not limited to, the following values:

642

# - "single" - Person is single.

643

# - "in_a_relationship" - Person is in a relationship.

644

# - "engaged" - Person is engaged.

645

# - "married" - Person is married.

646

# - "its_complicated" - The relationship is complicated.

647

# - "open_relationship" - Person is in an open relationship.

648

# - "widowed" - Person is widowed.

649

# - "in_domestic_partnership" - Person is in a domestic partnership.

650

# - "in_civil_union" - Person is in a civil union.

651

"skills": "A String", # The person's skills.

652

"tagline": "A String", # The brief description (tagline) of this person.

653

"url": "A String", # The URL of this person's profile.

654

"urls": [ # A list of URLs for this person.

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

655

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

656

"label": "A String", # The label of the URL.

657

"type": "A String", # The type of URL. Possible values include, but are not limited to, the following values:

658

# - "otherProfile" - URL for another profile.

659

# - "contributor" - URL to a site for which this person is a contributor.

660

# - "website" - URL for this Google+ Page's primary website.

661

# - "other" - Other URL.

662

"value": "A String", # The URL value.

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

663

},

664

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

665

"verified": True or False, # Whether the person or Google+ Page has been verified.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

666

},

667

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

668

"kind": "plus#peopleFeed", # Identifies this resource as a collection of people. Value: "plus#peopleFeed".

669

"nextPageToken": "A String", # The continuation token, which is used to page through large result sets. Provide this value in a subsequent request to return the next page of results.

670

"selfLink": "A String", # Link to this resource.

671

"title": "A String", # The title of this collection of people.

672

"totalItems": 42, # The total number of people available in this list. The number of people in a response might be smaller due to paging. This might not be set for all collections.

John Asmuth