gdata-python-client/pydocs/gdata.maps.client.html at master · GauravSahu/gdata-python-client

Repository navigation

History

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

115

116

117

118

119

120

121

122

123

124

125

126

127

128

129

130

131

132

133

134

135

136

137

138

139

140

141

142

143

144

145

146

147

148

149

150

151

152

153

154

155

156

157

158

159

160

161

162

163

164

165

166

167

168

169

170

171

172

173

174

175

176

177

178

179

180

181

182

183

184

185

186

187

188

189

190

191

192

193

194

195

196

197

198

199

200

201

202

203

204

205

206

207

208

209

210

211

212

213

214

215

216

217

218

219

220

221

222

223

224

225

226

227

228

229

230

231

232

233

234

235

236

237

238

239

240

241

242

243

244

245

246

247

248

249

250

251

252

253

254

255

256

257

258

259

260

261

262

263

264

265

266

267

268

269

270

271

272

273

274

275

276

277

278

279

280

281

282

283

284

285

286

287

288

289

290

291

292

293

294

295

296

297

298

299

300

301

302

303

304

305

306

307

308

309

310

311

312

313

314

315

316

317

318

319

320

321

322

323

324

325

326

327

328

329

330

331

332

333

334

335

336

337

338

339

340

341

342

343

344

345

346

347

348

349

350

351

352

353

354

355

356

357

358

359

360

361

362

363

364

365

366

367

368

369

370

371

372

373

374

375

376

377

378

379

380

381

382

383

384

385

386

387

388

389

390

391

392

393

394

395

396

397

398

399

400

401

402

403

404

405

406

407

408

409

410

411

412

413

414

415

416

417

418

419

420

421

422

423

424

425

426

427

428

429

430

431

432

433

434

435

436

437

438

439

440

441

442

443

444

445

446

447

448

449

450

451

452

453

454

455

456

457

458

459

460

461

462

463

464

465

466

467

468

469

470

471

472

473

474

475

476

477

478

479

480

481

482

483

484

485

486

487

488

489

490

491

492

493

494

495

496

497

498

499

500

501

502

503

504

505

506

507

508

509

510

511

512

513

514

515

516

517

518

519

520

521

522

523

524

525

526

527

528

529

530

531

532

533

534

535

536

537

538

539

540

541

542

543

544

545

546

547

548

549

550

551

552

553

554

555

556

557

558

559

560

561

562

563

564

565

566

567

568

569

570

571

572

573

574

575

576

577

578

579

580

581

582

583

584

585

586

587

588

589

590

591

592

593

594

595

596

597

598

599

600

601

602

603

604

605

606

607

608

609

610

611

612

613

614

615

<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">

<html><head><title>Python: module gdata.maps.client</title>

</head><body bgcolor="#f0f0f8">

<big><big><a href="gdata.html">gdata</a>.<a href="gdata.maps.html">maps</a>.client</big></big></td

><td align=right valign=bottom

><a href=".">index</a> <a href="file:/usr/local/lib/python2.6/dist-packages/gdata/maps/client.py">/usr/local/lib/python2.6/dist-packages/gdata/maps/client.py</a></td></tr></table>

<tt>Contains a client to communicate with the Maps Data servers.

For documentation on the Maps Data API, see:

<a href="http://code.google.com/apis/maps/documentation/mapsdata/">http://code.google.com/apis/maps/documentation/mapsdata/</a></tt>

<big>Modules</big></td></tr>

</td><td width="25%" valign=top><a href="gdata.html">gdata</a>

</td><td width="25%" valign=top></td><td width="25%" valign=top></td></tr></table></td></tr></table>

<big>Classes</big></td></tr>

<dt><a href="gdata.client.html#GDClient">gdata.client.GDClient</a>(<a href="atom.client.html#AtomPubClient">atom.client.AtomPubClient</a>)

</dt><dd>

<dl>

<dt><a href="gdata.maps.client.html#MapsClient">MapsClient</a>

</dt></dl>

</dd>

</dl>

<a name="MapsClient">class MapsClient</a>(<a href="gdata.client.html#GDClient">gdata.client.GDClient</a>)</td></tr>

<td colspan=2><tt>Maps Data API GData client.  </tt></td></tr>

<td width="100%"><dl><dt>Method resolution order:</dt>

<dd><a href="gdata.maps.client.html#MapsClient">MapsClient</a></dd>

<dd><a href="gdata.client.html#GDClient">gdata.client.GDClient</a></dd>

<dd><a href="atom.client.html#AtomPubClient">atom.client.AtomPubClient</a></dd>

<dd><a href="__builtin__.html#object">__builtin__.object</a></dd>

</dl>

<hr>

Methods defined here:

<dl><dt><a name="MapsClient-AddFeature">AddFeature</a> = <a href="#MapsClient-add_feature">add_feature</a>(self, map_id, title, content, auth_token=None, title_type='text', content_type='application/vnd.google-earth.kml+xml', **kwargs)</dt></dl>

<dl><dt><a name="MapsClient-CreateMap">CreateMap</a> = <a href="#MapsClient-create_map">create_map</a>(self, title, summary=None, unlisted=False, auth_token=None, title_type='text', summary_type='text', **kwargs)</dt></dl>

<dl><dt><a name="MapsClient-Delete">Delete</a> = <a href="#MapsClient-delete">delete</a>(self, entry_or_uri, auth_token=None, **kwargs)</dt></dl>

<dl><dt><a name="MapsClient-GetFeatures">GetFeatures</a> = <a href="#MapsClient-get_features">get_features</a>(self, map_id, user_id='default', auth_token=None, desired_class=<class 'gdata.maps.data.FeatureFeed'>, query=None, **kwargs)</dt></dl>

<dl><dt><a name="MapsClient-GetMaps">GetMaps</a> = <a href="#MapsClient-get_maps">get_maps</a>(self, user_id='default', auth_token=None, desired_class=<class 'gdata.maps.data.MapFeed'>, **kwargs)</dt></dl>

<dl><dt><a name="MapsClient-Update">Update</a> = <a href="#MapsClient-update">update</a>(self, entry, auth_token=None, **kwargs)</dt></dl>

<dl><dt><a name="MapsClient-add_feature">add_feature</a>(self, map_id, title, content, auth_token=None, title_type='text', content_type='application/vnd.google-earth.kml+xml', **kwargs)</dt><dd><tt>Adds a new feature to the given map.

Args:

map_id: A string representing the ID of the map to which the new feature

should be added.

title: A string representing the name/title of the new feature.

content: A KML string or gdata.maps.data.KmlContent object representing

the new feature's KML contents, including its description.

Returns:

A gdata.maps.data.Feature.</tt></dd></dl>

<dl><dt><a name="MapsClient-create_map">create_map</a>(self, title, summary=None, unlisted=False, auth_token=None, title_type='text', summary_type='text', **kwargs)</dt><dd><tt>Creates a new map and posts it to the Maps Data servers.

Args:

title: A string representing the title of the new map.

summary: An optional string representing the new map's description.

unlisted: An optional boolean identifying whether the map should be

unlisted (True) or public (False). Default False.

Returns:

A gdata.maps.data.Map.</tt></dd></dl>

<dl><dt><a name="MapsClient-delete">delete</a>(self, entry_or_uri, auth_token=None, **kwargs)</dt><dd><tt>Deletes the given entry or entry URI server-side.

Args:

entry_or_uri: A gdata.maps.data.Map, gdata.maps.data.Feature, or URI

string representing the entry to delete.</tt></dd></dl>

<dl><dt><a name="MapsClient-get_features">get_features</a>(self, map_id, user_id='default', auth_token=None, desired_class=<class 'gdata.maps.data.FeatureFeed'>, query=None, **kwargs)</dt><dd><tt>Retrieves a Feature feed for the given map ID/user ID combination.

Args:

map_id: A string representing the ID of the map whose features should be

retrieved.

user_id: An optional string representing the user ID; should be 'default'.

Returns:

A gdata.maps.data.FeatureFeed.</tt></dd></dl>

<dl><dt><a name="MapsClient-get_maps">get_maps</a>(self, user_id='default', auth_token=None, desired_class=<class 'gdata.maps.data.MapFeed'>, **kwargs)</dt><dd><tt>Retrieves a Map feed for the given user ID.

Args:

user_id: An optional string representing the user ID; should be 'default'.

Returns:

A gdata.maps.data.MapFeed.</tt></dd></dl>

<dl><dt><a name="MapsClient-update">update</a>(self, entry, auth_token=None, **kwargs)</dt><dd><tt>Sends changes to a given map or feature entry to the Maps Data servers.

Args:

entry: A gdata.maps.data.Map or gdata.maps.data.Feature to be updated

server-side.</tt></dd></dl>

<hr>

Data and other attributes defined here:

<dl><dt>api_version = '2'</dl>

<dl><dt>auth_scopes = ('http://maps.google.com/maps/feeds/',)</dl>

<dl><dt>auth_service = 'local'</dl>

<hr>

Methods inherited from <a href="gdata.client.html#GDClient">gdata.client.GDClient</a>:

<dl><dt><a name="MapsClient-ClientLogin">ClientLogin</a> = client_login(self, email, password, source, service=None, account_type='HOSTED_OR_GOOGLE', auth_url=<atom.http_core.Uri object>, captcha_token=None, captcha_response=None)</dt><dd><tt>Performs an auth request using the user's email address and password.

In order to modify user specific data and read user private data, your

application must be authorized by the user. One way to demonstrage

authorization is by including a Client Login token in the Authorization

HTTP header of all requests. This method requests the Client Login token

by sending the user's email address, password, the name of the

application, and the service code for the service which will be accessed

by the application. If the username and password are correct, the server

will respond with the client login code and a new ClientLoginToken

object will be set in the client's auth_token member. With the auth_token

set, future requests from this client will include the Client Login

token.

For a list of service names, see

<a href="http://code.google.com/apis/gdata/faq.html#clientlogin">http://code.google.com/apis/gdata/faq.html#clientlogin</a>

For more information on Client Login, see:

<a href="http://code.google.com/apis/accounts/docs/AuthForInstalledApps.html">http://code.google.com/apis/accounts/docs/AuthForInstalledApps.html</a>

Args:

email: str The user's email address or username.

password: str The password for the user's account.

source: str The name of your application. This can be anything you

like but should should give some indication of which app is

making the request.

service: str The service code for the service you would like to access.

For example, 'cp' for contacts, 'cl' for calendar. For a full

list see

<a href="http://code.google.com/apis/gdata/faq.html#clientlogin">http://code.google.com/apis/gdata/faq.html#clientlogin</a>

If you are using a subclass of the gdata.client.<a href="gdata.client.html#GDClient">GDClient</a>, the

service will usually be filled in for you so you do not need

to specify it. For example see BloggerClient,

SpreadsheetsClient, etc.

account_type: str (optional) The type of account which is being

authenticated. This can be either 'GOOGLE' for a Google

Account, 'HOSTED' for a Google Apps Account, or the

default 'HOSTED_OR_GOOGLE' which will select the Google

Apps Account if the same email address is used for both

a Google Account and a Google Apps Account.

auth_url: str (optional) The URL to which the login request should be

sent.

captcha_token: str (optional) If a previous login attempt was reponded

to with a CAPTCHA challenge, this is the token which

identifies the challenge (from the CAPTCHA's URL).

captcha_response: str (optional) If a previous login attempt was

reponded to with a CAPTCHA challenge, this is the

response text which was contained in the challenge.

Returns:

None

Raises:

A RequestError or one of its suclasses: BadAuthentication,

BadAuthenticationServiceURL, ClientLoginFailed,

ClientLoginTokenMissing, or CaptchaChallenge</tt></dd></dl>

<dl><dt><a name="MapsClient-GetAccessToken">GetAccessToken</a> = get_access_token(self, request_token, url='https://www.google.com/accounts/OAuthGetAccessToken')</dt><dd><tt>Exchanges an authorized OAuth request token for an access token.

Contacts the Google OAuth server to upgrade a previously authorized

request token. Once the request token is upgraded to an access token,

the access token may be used to access the user's data.

For more details, see the Google Accounts OAuth documentation:

<a href="http://code.google.com/apis/accounts/docs/OAuth.html#AccessToken">http://code.google.com/apis/accounts/docs/OAuth.html#AccessToken</a>

Args:

request_token: An OAuth token which has been authorized by the user.

url: (optional) The URL to which the upgrade request should be sent.

Defaults to: https://www.google.com/accounts/OAuthAuthorizeToken</tt></dd></dl>

<dl><dt><a name="MapsClient-GetEntry">GetEntry</a> = get_entry(self, uri, auth_token=None, converter=None, desired_class=<class 'gdata.data.GDEntry'>, etag=None, **kwargs)</dt></dl>

<dl><dt><a name="MapsClient-GetFeed">GetFeed</a> = get_feed(self, uri, auth_token=None, converter=None, desired_class=<class 'gdata.data.GDFeed'>, **kwargs)</dt></dl>

<dl><dt><a name="MapsClient-GetNext">GetNext</a> = get_next(self, feed, auth_token=None, converter=None, desired_class=None, **kwargs)</dt><dd><tt>Fetches the next set of results from the feed.

When requesting a feed, the number of entries returned is capped at a

service specific default limit (often 25 entries). You can specify your

own entry-count cap using the max-results URL query parameter. If there

are more results than could fit under max-results, the feed will contain

a next link. This method performs a GET against this next results URL.

Returns:

A new feed object containing the next set of entries in this feed.</tt></dd></dl>

<dl><dt><a name="MapsClient-GetOAuthToken">GetOAuthToken</a> = get_oauth_token(self, scopes, next, consumer_key, consumer_secret=None, rsa_private_key=None, url='https://www.google.com/accounts/OAuthGetRequestToken')</dt><dd><tt>Obtains an OAuth request token to allow the user to authorize this app.

Once this client has a request token, the user can authorize the request

token by visiting the authorization URL in their browser. After being

redirected back to this app at the 'next' URL, this app can then exchange

the authorized request token for an access token.

For more information see the documentation on Google Accounts with OAuth:

<a href="http://code.google.com/apis/accounts/docs/OAuth.html#AuthProcess">http://code.google.com/apis/accounts/docs/OAuth.html#AuthProcess</a>

Args:

scopes: list of strings or atom.http_core.Uri objects which specify the

URL prefixes which this app will be accessing. For example, to access

the Google Calendar API, you would want to use scopes:

['https://www.google.com/calendar/feeds/',

'<a href="http://www.google.com/calendar/feeds/">http://www.google.com/calendar/feeds/</a>']

next: str or atom.http_core.Uri object, The URL which the user's browser

should be sent to after they authorize access to their data. This

should be a URL in your application which will read the token

information from the URL and upgrade the request token to an access

token.

consumer_key: str This is the identifier for this application which you

should have received when you registered your application with Google

to use OAuth.

consumer_secret: str (optional) The shared secret between your app and

Google which provides evidence that this request is coming from you

application and not another app. If present, this libraries assumes

you want to use an HMAC signature to verify requests. Keep this data

a secret.

rsa_private_key: str (optional) The RSA private key which is used to

generate a digital signature which is checked by Google's server. If

present, this library assumes that you want to use an RSA signature

to verify requests. Keep this data a secret.

url: The URL to which a request for a token should be made. The default

is Google's OAuth request token provider.</tt></dd></dl>

<dl><dt><a name="MapsClient-ModifyRequest">ModifyRequest</a> = modify_request(self, http_request)</dt><dd><tt>Adds or changes request before making the HTTP request.

This client will add the API version if it is specified.

Subclasses may override this method to add their own request

modifications before the request is made.</tt></dd></dl>

<dl><dt><a name="MapsClient-Post">Post</a> = post(self, entry, uri, auth_token=None, converter=None, desired_class=None, **kwargs)</dt></dl>

<dl><dt><a name="MapsClient-Request">Request</a> = request(self, method=None, uri=None, auth_token=None, http_request=None, converter=None, desired_class=None, redirects_remaining=4, **kwargs)</dt><dd><tt>Make an HTTP request to the server.

See also documentation for atom.client.AtomPubClient.request.

If a 302 redirect is sent from the server to the client, this client

assumes that the redirect is in the form used by the Google Calendar API.

The same request URI and method will be used as in the original request,

but a gsessionid URL parameter will be added to the request URI with

the value provided in the server's 302 redirect response. If the 302

redirect is not in the format specified by the Google Calendar API, a

RedirectError will be raised containing the body of the server's

response.

The method calls the client's modify_request method to make any changes

required by the client before the request is made. For example, a

version 2 client could add a GData-Version: 2 header to the request in

its modify_request method.

Args:

method: str The HTTP verb for this request, usually 'GET', 'POST',

'PUT', or 'DELETE'

uri: atom.http_core.Uri, str, or unicode The URL being requested.

auth_token: An object which sets the Authorization HTTP header in its

modify_request method. Recommended classes include

gdata.gauth.ClientLoginToken and gdata.gauth.AuthSubToken

among others.

http_request: (optional) atom.http_core.HttpRequest

converter: function which takes the body of the response as it's only

argument and returns the desired object.

desired_class: class descended from atom.core.XmlElement to which a

successful response should be converted. If there is no

converter function specified (converter=None) then the

desired_class will be used in calling the

atom.core.parse function. If neither

the desired_class nor the converter is specified, an

HTTP reponse object will be returned.

redirects_remaining: (optional) int, if this number is 0 and the

server sends a 302 redirect, the request method

will raise an exception. This parameter is used in

recursive request calls to avoid an infinite loop.

Any additional arguments are passed through to

atom.client.AtomPubClient.request.

Returns:

An HTTP response object (see atom.http_core.HttpResponse for a

description of the object's interface) if no converter was

specified and no desired_class was specified. If a converter function

was provided, the results of calling the converter are returned. If no

converter was specified but a desired_class was provided, the response

body will be converted to the class using

atom.core.parse.</tt></dd></dl>

<dl><dt><a name="MapsClient-RequestClientLoginToken">RequestClientLoginToken</a> = request_client_login_token(self, email, password, source, service=None, account_type='HOSTED_OR_GOOGLE', auth_url=<atom.http_core.Uri object>, captcha_token=None, captcha_response=None)</dt></dl>

<dl><dt><a name="MapsClient-RevokeToken">RevokeToken</a> = revoke_token(self, token=None, url=<atom.http_core.Uri object>)</dt><dd><tt>Requests that the token be invalidated.

This method can be used for both AuthSub and OAuth tokens (to invalidate

a ClientLogin token, the user must change their password).

Returns:

True if the server responded with a 200.

Raises:

A RequestError if the server responds with a non-200 status.</tt></dd></dl>

<dl><dt><a name="MapsClient-UpgradeToken">UpgradeToken</a> = upgrade_token(self, token=None, url=<atom.http_core.Uri object>)</dt><dd><tt>Asks the Google auth server for a multi-use AuthSub token.

For details on AuthSub, see:

<a href="http://code.google.com/apis/accounts/docs/AuthSub.html">http://code.google.com/apis/accounts/docs/AuthSub.html</a>

Args:

token: gdata.gauth.AuthSubToken or gdata.gauth.SecureAuthSubToken

(optional) If no token is passed in, the client's auth_token member

is used to request the new token. The token object will be modified

to contain the new session token string.

url: str or atom.http_core.Uri (optional) The URL to which the token

upgrade request should be sent. Defaults to:

https://www.google.com/accounts/AuthSubSessionToken

Returns:

The upgraded gdata.gauth.AuthSubToken object.</tt></dd></dl>

<dl><dt><a name="MapsClient-client_login">client_login</a>(self, email, password, source, service=None, account_type='HOSTED_OR_GOOGLE', auth_url=<atom.http_core.Uri object>, captcha_token=None, captcha_response=None)</dt><dd><tt>Performs an auth request using the user's email address and password.