Blame - docs/dyn/firebase_v1beta1.projects.html - platform/external/python/google-api-python-client

"error": { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation.

231

# different programming environments, including REST APIs and RPC APIs. It is

232

# used by [gRPC](https://github.com/grpc). Each `Status` message contains

233

# three pieces of data: error code, error message, and error details.

234

#

235

# You can find out more about this error model and how to work with it in the

236

# [API Design Guide](https://cloud.google.com/apis/design/errors).

237

"message": "A String", # A developer-facing error message, which should be in English. Any

238

# user-facing error message should be localized and sent in the

239

# google.rpc.Status.details field, or localized by the client.

240

"details": [ # A list of messages that carry the error details. There is a common set of

241

# message types for APIs to use.

242

{

243

"a_key": "", # Properties of the object. Contains field @type with type URL.

244

},

245

],

246

"code": 42, # The status code, which should be an enum value of google.rpc.Code.

247

},

248

"metadata": { # Service-specific metadata associated with the operation. It typically

249

# contains progress information and common metadata such as create time.

250

# Some services might not provide such metadata. Any method that returns a

251

# long-running operation should document the metadata type, if any.

252

"a_key": "", # Properties of the object. Contains field @type with type URL.

},

}</pre>

</div>

<code class="details" id="addGoogleAnalytics">addGoogleAnalytics(parent, body=None, x__xgafv=None)</code>

259

<pre>Links a FirebaseProject with an existing

260

[Google Analytics account](http://www.google.com/analytics/).

261

262

Using this call, you can either:

263

<ul>

264

<li>Specify an `analyticsAccountId` to provision a new Google Analytics

265

property within the specified account and associate the new property with

266

your `FirebaseProject`.</li>

267

<li>Specify an existing `analyticsPropertyId` to associate the property

268

with your `FirebaseProject`.</li>

269

</ul>

270

271

Note that when you call `AddGoogleAnalytics`:

272

<ol>

273

<li>The first check determines if any existing data streams in the

274

Google Analytics property correspond to any existing Firebase Apps in your

275

`FirebaseProject` (based on the `packageName` or `bundleId` associated with

276

the data stream). Then, as applicable, the data streams and apps are

277

linked. Note that this auto-linking only applies to Android Apps and iOS

278

Apps.</li>

279

<li>If no corresponding data streams are found for your Firebase Apps,

280

new data streams are provisioned in the Google Analytics property

281

for each of your Firebase Apps. Note that a new data stream is always

282

provisioned for a Web App even if it was previously associated with a

283

data stream in your Analytics property.</li>

284

</ol>

285

Learn more about the hierarchy and structure of Google Analytics

286

accounts in the

287

[Analytics

288

documentation](https://support.google.com/analytics/answer/9303323).

289

290

The result of this call is an [`Operation`](../../v1beta1/operations).

291

Poll the `Operation` to track the provisioning process by calling

292

GetOperation until

293

[`done`](../../v1beta1/operations#Operation.FIELDS.done) is `true`. When

294

`done` is `true`, the `Operation` has either succeeded or failed. If the

295

`Operation` succeeded, its

296

[`response`](../../v1beta1/operations#Operation.FIELDS.response) is set to

297

an AnalyticsDetails; if the `Operation` failed, its

298

[`error`](../../v1beta1/operations#Operation.FIELDS.error) is set to a

299

google.rpc.Status.

300

301

To call `AddGoogleAnalytics`, a member must be an Owner for

302

the existing `FirebaseProject` and have the

303

[`Edit` permission](https://support.google.com/analytics/answer/2884495)

304

for the Google Analytics account.

305

306

If a `FirebaseProject` already has Google Analytics enabled, and you

307

call `AddGoogleAnalytics` using an `analyticsPropertyId` that's different

308

from the currently associated property, then the call will fail. Analytics

309

may have already been enabled in the Firebase console or by specifying

310

`timeZone` and `regionCode` in the call to

311

[`AddFirebase`](../../v1beta1/projects/addFirebase).

312

313

Args:

314

parent: string, The parent `FirebaseProject` to link to an existing Google Analytics

315

account, in the format:

316

<code>projects/<var>projectId</var></code> (required)

317

body: object, The request body.

318

The object takes the form of:

319

320

{

321

"analyticsPropertyId": "A String", # The ID for the existing Google Analytics property that you want to

322

# associate with your `FirebaseProject`.

323

"analyticsAccountId": "A String", # The ID for the existing

324

# [Google Analytics account](http://www.google.com/analytics/) that you

325

# want to link with your `FirebaseProject`.

326

#

327

# Specifying this field will provision a new Google Analytics

328

# property in your Google Analytics account and associate the new property

329

# with your `FirebaseProject`.

330

}

331

332

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

339

340

{ # This resource represents a long-running operation that is the result of a

341

# network API call.

342

"done": True or False, # If the value is `false`, it means the operation is still in progress.

343

# If `true`, the operation is completed, and either `error` or `response` is

344

# available.

345

"response": { # The normal response of the operation in case of success. If the original

346

# method returns no data on success, such as `Delete`, the response is

347

# `google.protobuf.Empty`. If the original method is standard

348

# `Get`/`Create`/`Update`, the response should be the resource. For other

349

# methods, the response should have the type `XxxResponse`, where `Xxx`

350

# is the original method name. For example, if the original method name

351

# is `TakeSnapshot()`, the inferred response type is

352

# `TakeSnapshotResponse`.

353

"a_key": "", # Properties of the object. Contains field @type with type URL.

354

},

355

"name": "A String", # The server-assigned name, which is only unique within the same service that

356

# originally returns it. If you use the default HTTP mapping, the

357

# `name` should be a resource name ending with `operations/{unique_id}`.

358

"error": { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation.

359

# different programming environments, including REST APIs and RPC APIs. It is

360

# used by [gRPC](https://github.com/grpc). Each `Status` message contains

361

# three pieces of data: error code, error message, and error details.

362

#

363

# You can find out more about this error model and how to work with it in the

364

# [API Design Guide](https://cloud.google.com/apis/design/errors).

365

"message": "A String", # A developer-facing error message, which should be in English. Any

366

# user-facing error message should be localized and sent in the

367

# google.rpc.Status.details field, or localized by the client.

368

"details": [ # A list of messages that carry the error details. There is a common set of

369

# message types for APIs to use.

370

{

371

"a_key": "", # Properties of the object. Contains field @type with type URL.

372

},

373

],

374

"code": 42, # The status code, which should be an enum value of google.rpc.Code.

375

},

376

"metadata": { # Service-specific metadata associated with the operation. It typically

377

# contains progress information and common metadata such as create time.

378

# Some services might not provide such metadata. Any method that returns a

379

# long-running operation should document the metadata type, if any.

380

"a_key": "", # Properties of the object. Contains field @type with type URL.

},

}</pre>

</div>

<code class="details" id="get">get(name, x__xgafv=None)</code>

387

<pre>Gets the FirebaseProject identified by the specified resource name.

Args:

<code>projects/<var>projectId</var></code> (required)

392

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

399

400

{ # A `FirebaseProject` is the top-level Firebase entity. It is the container for

401

# Firebase Apps, Firebase Hosting sites, storage systems (Firebase Realtime

402

# Database, Cloud Firestore, Cloud Storage buckets) and other Firebase and

403

# Google Cloud Platform (GCP) resources.

404

#

405

# You can create a new `FirebaseProject` in the

406

# [Firebase console](https://console.firebase.google.com/),

407

# or you can add Firebase resources to an existing

408

# [GCP

409

# `Project`](https://cloud.google.com/resource-manager/reference/rest/v1/projects)

# by calling

# AddFirebase.

#

# A `FirebaseProject` is actually also a GCP `Project`, so a

414

# `FirebaseProject` uses underlying GCP identifiers (most importantly,

415

# `projectId`) as its own for easy interop with GCP APIs.

Bu Sun Kim

6502091

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

[diff] [blame]

416

"resources": { # The default resources associated with a `FirebaseProject`. # The default Firebase resources associated with the Project.

Bu Sun Kim

4ed7d3f

2020-05-27 12:20:54 -0700

[diff] [blame]

417

"storageBucket": "A String", # The default Cloud Storage for Firebase storage bucket, in the format:

418

# <code><var>projectId</var>.appspot.com</code>

Bu Sun Kim

6502091

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

[diff] [blame]

419

"realtimeDatabaseInstance": "A String", # The default Firebase Realtime Database instance name, in the format:

420

# <code><var>projectId</var></code>

421

# Though rare, your `projectId` might already be used as the name for an

422

# existing Realtime Database instance in another project (learn more about

423

# [database

424

# sharding](https://firebase.google.com/docs/database/usage/sharding)). In

425

# these cases, your `projectId` is appended with a hyphen then five

426

# alphanumeric characters to create your default Realtime Database instance

427

# name. For example, if your `projectId` is `myproject123`, your default

428

# database instance name might be:

429

# <code>myproject123-a5c16</code>

430

"locationId": "A String", # The ID of the project's default GCP resource location. The location is one

431

# of the available

432

# [GCP resource

433

# locations](https://firebase.google.com/docs/projects/locations).

434

# This field is omitted if the default GCP resource location has not been

435

# finalized yet. To set your project's default GCP resource location,

436

# call [`FinalizeDefaultLocation`](../projects.defaultLocation/finalize)

437

# after you add Firebase services to your project.

438

"hostingSite": "A String", # The default Firebase Hosting site name, in the format:

439

# <code><var>projectId</var></code>

440

# Though rare, your `projectId` might already be used as the name for an

441

# existing Hosting site in another project (learn more about creating

442

# non-default,

443

# [additional sites](https://firebase.google.com/docs/hosting/multisites)).

444

# In these cases, your `projectId` is appended with a hyphen then five

445

# alphanumeric characters to create your default Hosting site name. For

446

# example, if your `projectId` is `myproject123`, your default Hosting site

447

# name might be:

448

# <code>myproject123-a5c16</code>

Bu Sun Kim

6502091

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

[diff] [blame]

449

},

Bu Sun Kim

4ed7d3f

2020-05-27 12:20:54 -0700

[diff] [blame]

450

"name": "A String", # The fully qualified resource name of the Project, in the format:

451

# <code>projects/<var>projectId</var></code>

452

"displayName": "A String", # The user-assigned display name of the Project.

453

"projectId": "A String", # Immutable. The globally unique, user-assigned ID of the Project.

454

"projectNumber": "A String", # The globally unique, Google-assigned identifier of the Project.

Bu Sun Kim

6502091

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

[diff] [blame]

}</pre>

</div>

<code class="details" id="getAdminSdkConfig">getAdminSdkConfig(name, x__xgafv=None)</code>

460

<pre>Gets the configuration artifact used by servers to simplify initialization.

461

462

Typically, this configuration is used with the Firebase Admin SDK

463

[initializeApp](https://firebase.google.com/docs/admin/setup#initialize_the_sdk)

command.

Args:

<code>projects/<var>projectId</var>/adminSdkConfig</code> (required)

469

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

476

477

{

Bu Sun Kim

4ed7d3f

2020-05-27 12:20:54 -0700

[diff] [blame]

478

"storageBucket": "A String", # The default Cloud Storage for Firebase storage bucket name.

Bu Sun Kim

6502091

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

[diff] [blame]

479

"locationId": "A String", # The ID of the project's default GCP resource location. The location is one

480

# of the available

481

# [GCP resource

482

# locations](https://firebase.google.com/docs/projects/locations).

483

# This field is omitted if the default GCP resource location has not been

484

# finalized yet. To set your project's default GCP resource location,

485

# call [`FinalizeDefaultLocation`](../projects.defaultLocation/finalize)

486

# after you add Firebase services to your project.

487

"projectId": "A String", # Immutable. The globally unique, user-assigned project ID of the parent

488

# Project.

489

"databaseURL": "A String", # The default Firebase Realtime Database URL.

Bu Sun Kim

6502091

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

[diff] [blame]

}</pre>

</div>

<code class="details" id="getAnalyticsDetails">getAnalyticsDetails(name, x__xgafv=None)</code>

495

<pre>Gets the Google Analytics details currently associated with a

496

FirebaseProject.

497

498

If the `FirebaseProject` is not yet linked to Google Analytics, then

499

the response to `GetAnalyticsDetails` is NOT_FOUND.

Args:

<code>projects/<var>projectId</var>/analyticsDetails</code> (required)

504

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

511

512

{

513

"analyticsProperty": { # Details of a Google Analytics property # The Analytics Property object associated with the specified

514

# `FirebaseProject`.

515

#

516

# This object contains the details of the Google Analytics property

517

# associated with the specified `FirebaseProject`.

Bu Sun Kim

6502091

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

[diff] [blame]

518

"id": "A String", # The globally unique, Google-assigned identifier of the Google Analytics

519

# property associated with the specified `FirebaseProject`.

520

#

521

# If you called

522

# [`AddGoogleAnalytics`](../../v1beta1/projects/addGoogleAnalytics) to link

523

# your `FirebaseProject` with a Google Analytics account, the value in this

524

# `id` field is the same as the ID of the property either specified or

525

# provisioned with that call to `AddGoogleAnalytics`.

Bu Sun Kim

4ed7d3f

2020-05-27 12:20:54 -0700

[diff] [blame]

526

"displayName": "A String", # The display name of the Google Analytics property associated with the

527

# specified `FirebaseProject`.

Bu Sun Kim

6502091

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

[diff] [blame]

528

},

529

"streamMappings": [ # For Android Apps and iOS Apps: A map of `app` to `streamId` for each

530

# Firebase App in the specified `FirebaseProject`. Each `app` and

531

# `streamId` appears only once.

532

#

533

# For Web Apps: A map of `app` to `streamId` and `measurementId` for each

534

# Firebase App in the specified `FirebaseProject`. Each `app`, `streamId`,

535

# and `measurementId` appears only once.

536

{ # A mapping of a Firebase App to a Google Analytics data stream

537

"streamId": "A String", # The unique Google-assigned identifier of the Google Analytics data stream

538

# associated with the Firebase App.

539

#

540

# Learn more about Google Analytics data streams in the

541

# [Analytics

542

# documentation](https://support.google.com/analytics/answer/9303323).

543

"app": "A String", # The fully qualified resource name of the Firebase App associated with the

544

# Google Analytics data stream, in the format:

545

# <code>projects/<var>projectId</var>/androidApps/<var>appId</var></code>

546

# or

547

# <code>projects/<var>projectId</var>/iosApps/<var>appId</var></code>

548

# or

549

# <code>projects/<var>projectId</var>/webApps/<var>appId</var></code>

550

"measurementId": "A String", # Applicable for Firebase Web Apps only.

551

# The unique Google-assigned identifier of the Google Analytics web

552

# stream associated with the Firebase Web App. Firebase SDKs use this ID to

553

# interact with Google Analytics APIs.

554

#

555

# Learn more about this ID and Google Analytics web streams in the

556

# [Analytics

557

# documentation](https://support.google.com/analytics/topic/9303475).

},

],

}</pre>

</div>

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

564

<code class="details" id="list">list(pageToken=None, pageSize=None, x__xgafv=None)</code>

Bu Sun Kim

6502091

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

[diff] [blame]

565

<pre>Lists each FirebaseProject accessible to the caller.

566

567

The elements are returned in no particular order, but they will be a

568

consistent view of the Projects when additional requests are made with a

569

`pageToken`.

570

571

This method is eventually consistent with Project mutations, which

572

means newly provisioned Projects and recent modifications to existing

573

Projects might not be reflected in the set of Projects. The list will

574

include only ACTIVE Projects.

Use

GetFirebaseProject

for consistent reads as well as for additional Project details.

579

580

Args:

Bu Sun Kim

4ed7d3f

2020-05-27 12:20:54 -0700

[diff] [blame]

581

pageToken: string, Token returned from a previous call to `ListFirebaseProjects` indicating

582

where in the set of Projects to resume listing.

Bu Sun Kim

6502091

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

[diff] [blame]

583

pageSize: integer, The maximum number of Projects to return in the response.

584

585

The server may return fewer than this at its discretion.

586

If no value is specified (or too large a value is specified), the server

587

will impose its own limit.

588

589

This value cannot be negative.

Bu Sun Kim

6502091

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

[diff] [blame]

590

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

597

598

{

599

"nextPageToken": "A String", # If the result list is too large to fit in a single response, then a token

600

# is returned. If the string is empty, then this response is the last page of

601

# results.

602

#

603

# This token can be used in a subsequent calls to `ListFirebaseProjects`

604

# to find the next group of Projects.

605

#

606

# Page tokens are short-lived and should not be persisted.

607

"results": [ # One page of the list of Projects that are accessible to the caller.

608

{ # A `FirebaseProject` is the top-level Firebase entity. It is the container for

609

# Firebase Apps, Firebase Hosting sites, storage systems (Firebase Realtime

610

# Database, Cloud Firestore, Cloud Storage buckets) and other Firebase and

611

# Google Cloud Platform (GCP) resources.

612

#

613

# You can create a new `FirebaseProject` in the

614

# [Firebase console](https://console.firebase.google.com/),

615

# or you can add Firebase resources to an existing

616

# [GCP

617

# `Project`](https://cloud.google.com/resource-manager/reference/rest/v1/projects)

# by calling

# AddFirebase.

#

# A `FirebaseProject` is actually also a GCP `Project`, so a

622

# `FirebaseProject` uses underlying GCP identifiers (most importantly,

623

# `projectId`) as its own for easy interop with GCP APIs.

Bu Sun Kim

6502091

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

[diff] [blame]

624

"resources": { # The default resources associated with a `FirebaseProject`. # The default Firebase resources associated with the Project.

Bu Sun Kim

4ed7d3f

2020-05-27 12:20:54 -0700

[diff] [blame]

625

"storageBucket": "A String", # The default Cloud Storage for Firebase storage bucket, in the format:

626

# <code><var>projectId</var>.appspot.com</code>

Bu Sun Kim

6502091

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

[diff] [blame]

627

"realtimeDatabaseInstance": "A String", # The default Firebase Realtime Database instance name, in the format:

628

# <code><var>projectId</var></code>

629

# Though rare, your `projectId` might already be used as the name for an

630

# existing Realtime Database instance in another project (learn more about

631

# [database

632

# sharding](https://firebase.google.com/docs/database/usage/sharding)). In

633

# these cases, your `projectId` is appended with a hyphen then five

634

# alphanumeric characters to create your default Realtime Database instance

635

# name. For example, if your `projectId` is `myproject123`, your default

636

# database instance name might be:

637

# <code>myproject123-a5c16</code>

638

"locationId": "A String", # The ID of the project's default GCP resource location. The location is one

639

# of the available

640

# [GCP resource

641

# locations](https://firebase.google.com/docs/projects/locations).

642

# This field is omitted if the default GCP resource location has not been

643

# finalized yet. To set your project's default GCP resource location,

644

# call [`FinalizeDefaultLocation`](../projects.defaultLocation/finalize)

645

# after you add Firebase services to your project.

646

"hostingSite": "A String", # The default Firebase Hosting site name, in the format:

647

# <code><var>projectId</var></code>

648

# Though rare, your `projectId` might already be used as the name for an

649

# existing Hosting site in another project (learn more about creating

650

# non-default,

651

# [additional sites](https://firebase.google.com/docs/hosting/multisites)).

652

# In these cases, your `projectId` is appended with a hyphen then five

653

# alphanumeric characters to create your default Hosting site name. For

654

# example, if your `projectId` is `myproject123`, your default Hosting site

655

# name might be:

656

# <code>myproject123-a5c16</code>

Bu Sun Kim

6502091

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

[diff] [blame]

657

},

Bu Sun Kim

4ed7d3f

2020-05-27 12:20:54 -0700

[diff] [blame]

658

"name": "A String", # The fully qualified resource name of the Project, in the format:

659

# <code>projects/<var>projectId</var></code>

660

"displayName": "A String", # The user-assigned display name of the Project.

661

"projectId": "A String", # Immutable. The globally unique, user-assigned ID of the Project.

662

"projectNumber": "A String", # The globally unique, Google-assigned identifier of the Project.

Bu Sun Kim

6502091

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

[diff] [blame]

},

],

}</pre>

</div>

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

670

<pre>Retrieves the next page of results.

671

672

Args:

673

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

674

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

675

676

Returns:

677

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

678

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

</pre>

</div>

<code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code>

684

<pre>Updates the attributes of the FirebaseProject identified by the

685

specified resource name.

686

687

All [query parameters](#query-parameters) are required.

Args:

<code>projects/<var>projectId</var></code> (required)

692

body: object, The request body.

693

The object takes the form of:

694

695

{ # A `FirebaseProject` is the top-level Firebase entity. It is the container for

696

# Firebase Apps, Firebase Hosting sites, storage systems (Firebase Realtime

697

# Database, Cloud Firestore, Cloud Storage buckets) and other Firebase and

698

# Google Cloud Platform (GCP) resources.

699

#

700

# You can create a new `FirebaseProject` in the

701

# [Firebase console](https://console.firebase.google.com/),

702

# or you can add Firebase resources to an existing

703

# [GCP

704

# `Project`](https://cloud.google.com/resource-manager/reference/rest/v1/projects)

# by calling

# AddFirebase.

#

# A `FirebaseProject` is actually also a GCP `Project`, so a

709

# `FirebaseProject` uses underlying GCP identifiers (most importantly,

710

# `projectId`) as its own for easy interop with GCP APIs.

Bu Sun Kim

6502091

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

[diff] [blame]

711

"resources": { # The default resources associated with a `FirebaseProject`. # The default Firebase resources associated with the Project.

Bu Sun Kim

4ed7d3f

2020-05-27 12:20:54 -0700

[diff] [blame]

712

"storageBucket": "A String", # The default Cloud Storage for Firebase storage bucket, in the format:

713

# <code><var>projectId</var>.appspot.com</code>

Bu Sun Kim

6502091

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

[diff] [blame]

714

"realtimeDatabaseInstance": "A String", # The default Firebase Realtime Database instance name, in the format:

715

# <code><var>projectId</var></code>

716

# Though rare, your `projectId` might already be used as the name for an

717

# existing Realtime Database instance in another project (learn more about

718

# [database

719

# sharding](https://firebase.google.com/docs/database/usage/sharding)). In

720

# these cases, your `projectId` is appended with a hyphen then five

721

# alphanumeric characters to create your default Realtime Database instance

722

# name. For example, if your `projectId` is `myproject123`, your default

723

# database instance name might be:

724

# <code>myproject123-a5c16</code>

725

"locationId": "A String", # The ID of the project's default GCP resource location. The location is one

726

# of the available

727

# [GCP resource

728

# locations](https://firebase.google.com/docs/projects/locations).

729

# This field is omitted if the default GCP resource location has not been

730

# finalized yet. To set your project's default GCP resource location,

731

# call [`FinalizeDefaultLocation`](../projects.defaultLocation/finalize)

732

# after you add Firebase services to your project.

733

"hostingSite": "A String", # The default Firebase Hosting site name, in the format:

734

# <code><var>projectId</var></code>

735

# Though rare, your `projectId` might already be used as the name for an

736

# existing Hosting site in another project (learn more about creating

737

# non-default,

738

# [additional sites](https://firebase.google.com/docs/hosting/multisites)).

739

# In these cases, your `projectId` is appended with a hyphen then five

740

# alphanumeric characters to create your default Hosting site name. For

741

# example, if your `projectId` is `myproject123`, your default Hosting site

742

# name might be:

743

# <code>myproject123-a5c16</code>

Bu Sun Kim

6502091

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

[diff] [blame]

744

},

Bu Sun Kim

4ed7d3f

2020-05-27 12:20:54 -0700

[diff] [blame]

745

"name": "A String", # The fully qualified resource name of the Project, in the format:

746

# <code>projects/<var>projectId</var></code>

747

"displayName": "A String", # The user-assigned display name of the Project.

748

"projectId": "A String", # Immutable. The globally unique, user-assigned ID of the Project.

749

"projectNumber": "A String", # The globally unique, Google-assigned identifier of the Project.

Bu Sun Kim

6502091

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

[diff] [blame]

750

}

751

752

updateMask: string, Specifies which fields to update.

753

754

If this list is empty, then no state will be updated.

755

Note that the fields `name`, `project_id`, and `project_number` are all

756

immutable.

757

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

764

765

{ # A `FirebaseProject` is the top-level Firebase entity. It is the container for

766

# Firebase Apps, Firebase Hosting sites, storage systems (Firebase Realtime

767

# Database, Cloud Firestore, Cloud Storage buckets) and other Firebase and

768

# Google Cloud Platform (GCP) resources.

769

#

770

# You can create a new `FirebaseProject` in the

771

# [Firebase console](https://console.firebase.google.com/),

772

# or you can add Firebase resources to an existing

773

# [GCP

774

# `Project`](https://cloud.google.com/resource-manager/reference/rest/v1/projects)

# by calling

# AddFirebase.

#

# A `FirebaseProject` is actually also a GCP `Project`, so a

779

# `FirebaseProject` uses underlying GCP identifiers (most importantly,

780

# `projectId`) as its own for easy interop with GCP APIs.

Bu Sun Kim

6502091

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

[diff] [blame]

781

"resources": { # The default resources associated with a `FirebaseProject`. # The default Firebase resources associated with the Project.

Bu Sun Kim

4ed7d3f

2020-05-27 12:20:54 -0700

[diff] [blame]

782

"storageBucket": "A String", # The default Cloud Storage for Firebase storage bucket, in the format:

783

# <code><var>projectId</var>.appspot.com</code>

Bu Sun Kim

6502091

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

[diff] [blame]

784

"realtimeDatabaseInstance": "A String", # The default Firebase Realtime Database instance name, in the format:

785

# <code><var>projectId</var></code>

786

# Though rare, your `projectId` might already be used as the name for an

787

# existing Realtime Database instance in another project (learn more about

788

# [database

789

# sharding](https://firebase.google.com/docs/database/usage/sharding)). In

790

# these cases, your `projectId` is appended with a hyphen then five

791

# alphanumeric characters to create your default Realtime Database instance

792

# name. For example, if your `projectId` is `myproject123`, your default

793

# database instance name might be:

794

# <code>myproject123-a5c16</code>

795

"locationId": "A String", # The ID of the project's default GCP resource location. The location is one

796

# of the available

797

# [GCP resource

798

# locations](https://firebase.google.com/docs/projects/locations).

799

# This field is omitted if the default GCP resource location has not been

800

# finalized yet. To set your project's default GCP resource location,

801

# call [`FinalizeDefaultLocation`](../projects.defaultLocation/finalize)

802

# after you add Firebase services to your project.

803

"hostingSite": "A String", # The default Firebase Hosting site name, in the format:

804

# <code><var>projectId</var></code>

805

# Though rare, your `projectId` might already be used as the name for an

806

# existing Hosting site in another project (learn more about creating

807

# non-default,

808

# [additional sites](https://firebase.google.com/docs/hosting/multisites)).

809

# In these cases, your `projectId` is appended with a hyphen then five

810

# alphanumeric characters to create your default Hosting site name. For

811

# example, if your `projectId` is `myproject123`, your default Hosting site

812

# name might be:

813

# <code>myproject123-a5c16</code>

Bu Sun Kim

6502091

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

[diff] [blame]

814

},

Bu Sun Kim

4ed7d3f

2020-05-27 12:20:54 -0700

[diff] [blame]

815

"name": "A String", # The fully qualified resource name of the Project, in the format:

816

# <code>projects/<var>projectId</var></code>

817

"displayName": "A String", # The user-assigned display name of the Project.

818

"projectId": "A String", # Immutable. The globally unique, user-assigned ID of the Project.

819

"projectNumber": "A String", # The globally unique, Google-assigned identifier of the Project.

Bu Sun Kim

6502091

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

[diff] [blame]

}</pre>

</div>

<code class="details" id="removeAnalytics">removeAnalytics(parent, body=None, x__xgafv=None)</code>

825

<pre>Unlinks the specified `FirebaseProject` from its Google Analytics account.

826

827

This call removes the association of the specified `FirebaseProject`

828

with its current Google Analytics property. However, this call does not

829

delete the Google Analytics resources, such as the Google Analytics

830

property or any data streams.

831

832

These resources may be re-associated later to the `FirebaseProject` by

833

calling

834

[`AddGoogleAnalytics`](../../v1beta1/projects/addGoogleAnalytics) and

835

specifying the same `analyticsPropertyId`. For Android Apps and iOS Apps,

836

this call re-links data streams with their corresponding apps. However,

837

for Web Apps, this call provisions a new data stream for each Web

838

App.

839

840

To call `RemoveAnalytics`, a member must be an Owner for

841

the `FirebaseProject`.

842

843

Args:

844

parent: string, The parent `FirebaseProject` to unlink from its Google Analytics account,

845

in the format:

846

<code>projects/<var>projectId</var></code> (required)

847

body: object, The request body.

848

The object takes the form of:

849

850

{

851

"analyticsPropertyId": "A String", # Optional. The ID of the Google Analytics property associated with the

852

# specified `FirebaseProject`.

853

# <ul>

854

# <li>If not set, then the Google Analytics property that is currently

855

# associated with the specified `FirebaseProject` is removed.</li>

856

# <li>If set, and the specified `FirebaseProject` is currently associated

857

# with a different Google Analytics property, then the response is a

858

# `412 Precondition Failed` error.</li>

# </ul>

}

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

869

870

{ # A generic empty message that you can re-use to avoid defining duplicated

871

# empty messages in your APIs. A typical example is to use it as the request

872

# or the response type of an API method. For instance:

873

#

874

# service Foo {

875

# rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);

876

# }

877

#

878

# The JSON representation for `Empty` is empty JSON object `{}`.

}</pre>

</div>

<code class="details" id="searchApps">searchApps(parent, pageToken=None, pageSize=None, x__xgafv=None)</code>

884

<pre>A convenience method that lists all available Apps for the specified

885

FirebaseProject.

886

887

Typically, interaction with an App should be done using the

888

platform-specific service, but some tool use-cases require a summary of all

889

known Apps (such as for App selector interfaces).

890

891

Args:

892

parent: string, The parent Project for which to list Apps, in the format:

893

<code>projects/<var>projectId</var></code> (required)

894

pageToken: string, Token returned from a previous call to `SearchFirebaseApps` indicating

895

where in the set of Apps to resume listing.

896

pageSize: integer, The maximum number of Apps to return in the response.

897

898

The server may return fewer than this value at its discretion.

899

If no value is specified (or too large a value is specified), then the

900

server will impose its own limit.

901

902

This value cannot be negative.

903

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

910

911

{

912

"apps": [ # One page of results from a call to `SearchFirebaseApps`.

913

{ # A high-level summary of an App.

Bu Sun Kim

6502091

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

[diff] [blame]

914

"appId": "A String", # Immutable. The globally unique, Firebase-assigned identifier of the App.

915

#

916

# This identifier should be treated as an opaque token, as the data

917

# format is not specified.

918

"platform": "A String", # The platform of the Firebase App.

919

"name": "A String", # The fully qualified resource name of the Firebase App, in the format:

920

# <code>projects/<var>projectId</var>/iosApps/<var>appId</var></code>

921

# or <code>projects/<var>projectId</var>/androidApps/<var>appId</var>

922

# </code>

Bu Sun Kim

4ed7d3f

2020-05-27 12:20:54 -0700

[diff] [blame]

923

"displayName": "A String", # The user-assigned display name of the Firebase App.

Bu Sun Kim

6502091

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

[diff] [blame]

924

},

925

],

926

"nextPageToken": "A String", # If the result list is too large to fit in a single response, then a token

927

# is returned.

928

#

929

# This token can be used in a subsequent calls to `SearchFirebaseApps`

930

# to find the next group of Apps.

931

# If the string is empty, then this response is the last page of results.

932

# Page tokens are short-lived and should not be persisted.

}</pre>

</div>

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

938

<pre>Retrieves the next page of results.

939

940

Args:

941

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

942

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

943

944

Returns:

945

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

946

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

</pre>

</div>

</body></html>