projects/projectId/androidApps/appId
+ # The resource name of the AndroidApp, in the format:
+ # projects/PROJECT_IDENTIFIER/androidApps/APP_ID
+ # * PROJECT_IDENTIFIER: the parent Project's
+ # [`ProjectNumber`](../projects#FirebaseProject.FIELDS.project_number)
+ # ***(recommended)***
+ # or its [`ProjectId`](../projects#FirebaseProject.FIELDS.project_id).
+ # Learn more about using project identifiers in
+ # Google's [AIP 2510 standard](https://google.aip.dev/cloud/2510).
+ #
Note that the value for PROJECT_IDENTIFIER in any
+ # response body will be the `ProjectId`.
+ # * APP_ID: the globally unique, Firebase-assigned identifier
+ # for the App
+ # (see [`appId`](../projects.androidApps#AndroidApp.FIELDS.app_id)).
# Corresponds to the JSON property `name`
# @return [String]
attr_accessor :name
- # The canonical package name of the Android App as would appear in the
- # Google Play Developer Console.
+ # Immutable. The canonical package name of the Android app as would appear in
+ # the Google Play Developer Console.
# Corresponds to the JSON property `packageName`
# @return [String]
attr_accessor :package_name
- # The globally unique, user-assigned ID of the parent Project for the App.
+ # Immutable. A user-assigned unique identifier of the parent
+ # FirebaseProject for the `AndroidApp`.
# Corresponds to the JSON property `projectId`
# @return [String]
attr_accessor :project_id
@@ -272,7 +282,8 @@ module Google
# @return [String]
attr_accessor :config_file_contents
- # The filename that the configuration artifact is typically saved as.
+ # The filename that the configuration artifact for the `AndroidApp` is
+ # typically saved as.
#
For example: `google-services.json`
# Corresponds to the JSON property `configFilename`
# @return [String]
@@ -289,13 +300,13 @@ module Google
end
end
- # The default resources associated with a `FirebaseProject`.
+ # The default resources associated with the Project.
class DefaultResources
include Google::Apis::Core::Hashable
# The default Firebase Hosting site name, in the format:
- #
projectId
- #
Though rare, your `projectId` might already be used as the name for an
+ # PROJECT_ID
+ # Though rare, your `projectId` might already be used as the name for an
# existing Hosting site in another project (learn more about creating
# non-default,
# [additional sites](https://firebase.google.com/docs/hosting/multisites)).
@@ -303,26 +314,26 @@ module Google
# alphanumeric characters to create your default Hosting site name. For
# example, if your `projectId` is `myproject123`, your default Hosting site
# name might be:
- #
myproject123-a5c16
+ # `myproject123-a5c16`
# Corresponds to the JSON property `hostingSite`
# @return [String]
attr_accessor :hosting_site
- # The ID of the project's default GCP resource location. The location is one
+ # The ID of the Project's default GCP resource location. The location is one
# of the available
# [GCP resource
- # locations](https://firebase.google.com/docs/projects/locations).
- #
This field is omitted if the default GCP resource location has not been
- # finalized yet. To set your project's default GCP resource location,
+ # locations](https://firebase.google.com/docs/projects/locations).
+ # This field is omitted if the default GCP resource location has not been
+ # finalized yet. To set a Project's default GCP resource location,
# call [`FinalizeDefaultLocation`](../projects.defaultLocation/finalize)
- # after you add Firebase services to your project.
+ # after you add Firebase resources to the Project.
# Corresponds to the JSON property `locationId`
# @return [String]
attr_accessor :location_id
# The default Firebase Realtime Database instance name, in the format:
- #
projectId
- #
Though rare, your `projectId` might already be used as the name for an
+ # PROJECT_ID
+ # Though rare, your `projectId` might already be used as the name for an
# existing Realtime Database instance in another project (learn more about
# [database
# sharding](https://firebase.google.com/docs/database/usage/sharding)). In
@@ -330,13 +341,13 @@ module Google
# alphanumeric characters to create your default Realtime Database instance
# name. For example, if your `projectId` is `myproject123`, your default
# database instance name might be:
- #
myproject123-a5c16
+ # `myproject123-a5c16`
# Corresponds to the JSON property `realtimeDatabaseInstance`
# @return [String]
attr_accessor :realtime_database_instance
# The default Cloud Storage for Firebase storage bucket, in the format:
- #
projectId.appspot.com
+ # PROJECT_ID.appspot.com
# Corresponds to the JSON property `storageBucket`
# @return [String]
attr_accessor :storage_bucket
@@ -377,9 +388,8 @@ module Google
class FinalizeDefaultLocationRequest
include Google::Apis::Core::Hashable
- # The ID of the default GCP resource location for the Project. The location
- # must be one of the available
- # [GCP resource
+ # The ID of the Project's default GCP resource location. The location must be
+ # one of the available [GCP resource
# locations](https://firebase.google.com/docs/projects/locations).
# Corresponds to the JSON property `locationId`
# @return [String]
@@ -399,9 +409,9 @@ module Google
class FirebaseAppInfo
include Google::Apis::Core::Hashable
- # Immutable. The globally unique, Firebase-assigned identifier of the App.
- #
- #
This identifier should be treated as an opaque token, as the data
+ # Immutable. The globally unique, Firebase-assigned identifier for the
+ # `WebApp`.
+ # This identifier should be treated as an opaque token, as the data
# format is not specified.
# Corresponds to the JSON property `appId`
# @return [String]
@@ -412,10 +422,12 @@ module Google
# @return [String]
attr_accessor :display_name
- # The fully qualified resource name of the Firebase App, in the format:
- #
projects/projectId/iosApps/appId
- # or
projects/projectId/androidApps/appId
- #
+ # The resource name of the Firebase App, in the format:
+ # projects/PROJECT_ID/iosApps/APP_ID
+ # or
+ # projects/PROJECT_ID/androidApps/APP_ID
+ # or
+ # projects/PROJECT_ID/webApps/APP_ID
# Corresponds to the JSON property `name`
# @return [String]
attr_accessor :name
@@ -440,21 +452,18 @@ module Google
# A `FirebaseProject` is the top-level Firebase entity. It is the container for
# Firebase Apps, Firebase Hosting sites, storage systems (Firebase Realtime
- # Database, Cloud Firestore, Cloud Storage buckets) and other Firebase and
+ # Database, Cloud Firestore, Cloud Storage buckets), and other Firebase and
# Google Cloud Platform (GCP) resources.
- #
- #
You can create a new `FirebaseProject` in the
- # [Firebase console](https://console.firebase.google.com/),
- # or you can add Firebase resources to an existing
+ # You create a `FirebaseProject` by calling
+ # AddFirebase
+ # and specifying an *existing*
# [GCP
# `Project`](https://cloud.google.com/resource-manager/reference/rest/v1/
- # projects)
- # by calling
- # AddFirebase.
- #
- #
A `FirebaseProject` is actually also a GCP `Project`, so a
- # `FirebaseProject` uses underlying GCP identifiers (most importantly,
- # `projectId`) as its own for easy interop with GCP APIs.
+ # projects).
+ # This adds Firebase resources to the existing GCP `Project`.
+ # Since a FirebaseProject is actually also a GCP `Project`, a
+ # `FirebaseProject` has the same underlying GCP identifiers (`projectNumber`
+ # and `projectId`). This allows for easy interop with Google APIs.
class FirebaseProject
include Google::Apis::Core::Hashable
@@ -463,23 +472,37 @@ module Google
# @return [String]
attr_accessor :display_name
- # The fully qualified resource name of the Project, in the format:
- #
projects/projectId
+ # The resource name of the Project, in the format:
+ # projects/PROJECT_IDENTIFIER
+ # PROJECT_IDENTIFIER: the Project's
+ # [`ProjectNumber`](../projects#FirebaseProject.FIELDS.project_number)
+ # ***(recommended)***
+ # or its [`ProjectId`](../projects#FirebaseProject.FIELDS.project_id).
+ #
Learn more about using project identifiers in
+ # Google's [AIP 2510 standard](https://google.aip.dev/cloud/2510).
+ #
Note that the value for PROJECT_IDENTIFIER in any
+ # response body will be the `ProjectId`.
# Corresponds to the JSON property `name`
# @return [String]
attr_accessor :name
- # Immutable. The globally unique, user-assigned ID of the Project.
+ # Immutable. A user-assigned unique identifier for the Project.
+ # This identifier may appear in URLs or names for some Firebase resources
+ # associated with the Project, but it should generally be treated as a
+ # convenience alias to reference the Project.
# Corresponds to the JSON property `projectId`
# @return [String]
attr_accessor :project_id
- # The globally unique, Google-assigned identifier of the Project.
+ # Immutable. The globally unique, Google-assigned canonical identifier for
+ # the Project.
+ # Use this identifier when configuring integrations and/or
+ # making API calls to Firebase or third-party services.
# Corresponds to the JSON property `projectNumber`
# @return [Fixnum]
attr_accessor :project_number
- # The default resources associated with a `FirebaseProject`.
+ # The default resources associated with the Project.
# Corresponds to the JSON property `resources`
# @return [Google::Apis::FirebaseV1beta1::DefaultResources]
attr_accessor :resources
@@ -502,38 +525,49 @@ module Google
class IosApp
include Google::Apis::Core::Hashable
- # Immutable. The globally unique, Firebase-assigned identifier of the App.
- #
- #
This identifier should be treated as an opaque token, as the data
+ # Immutable. The globally unique, Firebase-assigned identifier for the
+ # `IosApp`.
+ # This identifier should be treated as an opaque token, as the data
# format is not specified.
# Corresponds to the JSON property `appId`
# @return [String]
attr_accessor :app_id
- # The automatically generated Apple ID assigned to the App by Apple in the
- # iOS App Store.
+ # The automatically generated Apple ID assigned to the iOS app by Apple in
+ # the iOS App Store.
# Corresponds to the JSON property `appStoreId`
# @return [String]
attr_accessor :app_store_id
- # The canonical bundle ID of the iOS App as it would appear in the iOS
- # AppStore.
+ # Immutable. The canonical bundle ID of the iOS app as it would appear in the
+ # iOS AppStore.
# Corresponds to the JSON property `bundleId`
# @return [String]
attr_accessor :bundle_id
- # The user-assigned display name of the App.
+ # The user-assigned display name for the `IosApp`.
# Corresponds to the JSON property `displayName`
# @return [String]
attr_accessor :display_name
- # The fully qualified resource name of the App, in the format:
- #
projects/projectId/iosApps/appId
+ # The resource name of the IosApp, in the format:
+ # projects/PROJECT_IDENTIFIER/iosApps/APP_ID
+ # * PROJECT_IDENTIFIER: the parent Project's
+ # [`ProjectNumber`](../projects#FirebaseProject.FIELDS.project_number)
+ # ***(recommended)***
+ # or its [`ProjectId`](../projects#FirebaseProject.FIELDS.project_id).
+ # Learn more about using project identifiers in
+ # Google's [AIP 2510 standard](https://google.aip.dev/cloud/2510).
+ #
Note that the value for PROJECT_IDENTIFIER in any
+ # response body will be the `ProjectId`.
+ # * APP_ID: the globally unique, Firebase-assigned identifier
+ # for the App (see [`appId`](../projects.iosApps#IosApp.FIELDS.app_id)).
# Corresponds to the JSON property `name`
# @return [String]
attr_accessor :name
- # The globally unique, user-assigned ID of the parent Project for the App.
+ # Immutable. A user-assigned unique identifier of the parent
+ # FirebaseProject for the `IosApp`.
# Corresponds to the JSON property `projectId`
# @return [String]
attr_accessor :project_id
@@ -563,7 +597,8 @@ module Google
# @return [String]
attr_accessor :config_file_contents
- # The filename that the configuration artifact is typically saved as.
+ # The filename that the configuration artifact for the `IosApp` is typically
+ # saved as.
#
For example: `GoogleService-Info.plist`
# Corresponds to the JSON property `configFilename`
# @return [String]
@@ -584,7 +619,7 @@ module Google
class ListAndroidAppsResponse
include Google::Apis::Core::Hashable
- # List of each AndroidApp that is in the parent Firebase Project.
+ # List of each `AndroidApp` associated with the specified `FirebaseProject`.
# Corresponds to the JSON property `apps`
# @return [Array]
attr_accessor :apps
@@ -592,11 +627,9 @@ module Google
# If the result list is too large to fit in a single response, then a token
# is returned. If the string is empty, then this response is the last page of
# results.
- #
- #
This token can be used in a subsequent call to `ListAndroidApps` to
+ # This token can be used in a subsequent call to `ListAndroidApps` to
# find the next group of Apps.
- #
- #
Page tokens are short-lived and should not be persisted.
+ # Page tokens are short-lived and should not be persisted.
# Corresponds to the JSON property `nextPageToken`
# @return [String]
attr_accessor :next_page_token
@@ -624,11 +657,9 @@ module Google
# If the result list is too large to fit in a single response, then a token
# is returned. If the string is empty, then this response is the last page of
# results and all available locations have been listed.
- #
- #
This token can be used in a subsequent call to
+ # This token can be used in a subsequent call to
# `ListAvailableLocations` to find more locations.
- #
- #
Page tokens are short-lived and should not be persisted.
+ # Page tokens are short-lived and should not be persisted.
# Corresponds to the JSON property `nextPageToken`
# @return [String]
attr_accessor :next_page_token
@@ -651,11 +682,9 @@ module Google
# If the result list is too large to fit in a single response, then a token
# is returned. If the string is empty, then this response is the last page of
# results.
- #
- #
This token can be used in a subsequent calls to `ListAvailableProjects`
- # to find the next group of GCP `Projects`.
- #
- #
Page tokens are short-lived and should not be persisted.
+ # This token can be used in a subsequent calls to `ListAvailableProjects`
+ # to find the next group of Projects.
+ # Page tokens are short-lived and should not be persisted.
# Corresponds to the JSON property `nextPageToken`
# @return [String]
attr_accessor :next_page_token
@@ -683,11 +712,9 @@ module Google
# If the result list is too large to fit in a single response, then a token
# is returned. If the string is empty, then this response is the last page of
# results.
- #
- #
This token can be used in a subsequent calls to `ListFirebaseProjects`
+ # This token can be used in a subsequent calls to `ListFirebaseProjects`
# to find the next group of Projects.
- #
- #
Page tokens are short-lived and should not be persisted.
+ # Page tokens are short-lived and should not be persisted.
# Corresponds to the JSON property `nextPageToken`
# @return [String]
attr_accessor :next_page_token
@@ -712,7 +739,7 @@ module Google
class ListIosAppsResponse
include Google::Apis::Core::Hashable
- # List of each IosApp that is in the parent Firebase Project.
+ # List of each `IosApp` associated with the specified `FirebaseProject`.
# Corresponds to the JSON property `apps`
# @return [Array]
attr_accessor :apps
@@ -720,11 +747,9 @@ module Google
# If the result list is too large to fit in a single response, then a token
# is returned. If the string is empty, then this response is the last page of
# results.
- #
- #
This token can be used in a subsequent call to `ListIosApps` to find
+ # This token can be used in a subsequent call to `ListIosApps` to find
# the next group of Apps.
- #
- #
Page tokens are short-lived and should not be persisted.
+ # Page tokens are short-lived and should not be persisted.
# Corresponds to the JSON property `nextPageToken`
# @return [String]
attr_accessor :next_page_token
@@ -744,7 +769,7 @@ module Google
class ListShaCertificatesResponse
include Google::Apis::Core::Hashable
- # The list of SHA certificates associated with the App.
+ # The list of each `ShaCertificate` associated with the `AndroidApp`.
# Corresponds to the JSON property `certificates`
# @return [Array]
attr_accessor :certificates
@@ -763,7 +788,7 @@ module Google
class ListWebAppsResponse
include Google::Apis::Core::Hashable
- # List of each WebApp that is in the parent Firebase Project.
+ # List of each `WebApp` associated with the specified `FirebaseProject`.
# Corresponds to the JSON property `apps`
# @return [Array]
attr_accessor :apps
@@ -771,11 +796,9 @@ module Google
# If the result list is too large to fit in a single response, then a token
# is returned. If the string is empty, then this response is the last page of
# results.
- #
- #
This token can be used in a subsequent call to `ListWebApps` to find
+ # This token can be used in a subsequent call to `ListWebApps` to find
# the next group of Apps.
- #
- #
Page tokens are short-lived and should not be persisted.
+ # Page tokens are short-lived and should not be persisted.
# Corresponds to the JSON property `nextPageToken`
# @return [String]
attr_accessor :next_page_token
@@ -791,7 +814,7 @@ module Google
end
end
- # A GCP resource location that can be selected for a Project.
+ # A GCP resource location that can be selected for a FirebaseProject.
class Location
include Google::Apis::Core::Hashable
@@ -908,28 +931,30 @@ module Google
class ProjectInfo
include Google::Apis::Core::Hashable
- # The user-assigned display name of the GCP `Project`, for example:
- # My App
+ # The user-assigned display name of the GCP `Project`, for example: `My App`
# Corresponds to the JSON property `displayName`
# @return [String]
attr_accessor :display_name
- # The ID of the project's default GCP resource location. The location is one
+ # The ID of the Project's default GCP resource location. The location is one
# of the available
# [GCP resource
- # locations](https://firebase.google.com/docs/projects/locations).
- # Not all projects will have this field populated. If it is not populated, it
- # means that the project does not yet have a default GCP resource location.
- # To set your project's default GCP resource location, call
+ # locations](https://firebase.google.com/docs/projects/locations).
+ # Not all Projects will have this field populated. If it is not populated, it
+ # means that the Project does not yet have a default GCP resource location.
+ # To set a Project's default GCP resource location, call
# [`FinalizeDefaultLocation`](../projects.defaultLocation/finalize) after you
- # add Firebase resources to your project.
+ # add Firebase resources to the Project.
# Corresponds to the JSON property `locationId`
# @return [String]
attr_accessor :location_id
# The resource name of the GCP `Project` to which Firebase resources can be
# added, in the format:
- #
projects/PROJECT_NUMBER
+ # projects/PROJECT_IDENTIFIER
+ # Refer to the `FirebaseProject`
+ # [`name`](../projects#FirebaseProject.FIELDS.name) field for details
+ # about PROJECT_IDENTIFIER values.
# Corresponds to the JSON property `project`
# @return [String]
attr_accessor :project
@@ -954,10 +979,12 @@ module Google
# specified `FirebaseProject`.
#
# - If not set, then the Google Analytics property that is currently
- # associated with the specified `FirebaseProject` is removed.
+ # associated with the specified `FirebaseProject` is removed.
+ #
projects/PROJECT_NUMBER/androidApps/APP_ID/sha/
- # SHA_ID
+ # The resource name of the ShaCertificate for the AndroidApp,
+ # in the format:
+ # projects/PROJECT_IDENTIFIER/androidApps/APP_ID/sha/
+ # SHA_HASH
+ # * PROJECT_IDENTIFIER: the parent Project's
+ # [`ProjectNumber`](../projects#FirebaseProject.FIELDS.project_number)
+ # ***(recommended)***
+ # or its [`ProjectId`](../projects#FirebaseProject.FIELDS.project_id).
+ # Learn more about using project identifiers in
+ # Google's [AIP 2510 standard](https://google.aip.dev/cloud/2510).
+ # projects/PROJECT_NUMBER/androidApps/APP_IDprojects/PROJECT_IDENTIFIER/androidApps/APP_ID
# or
- # projects/PROJECT_NUMBER/iosApps/APP_ID
+ # projects/PROJECT_IDENTIFIER/iosApps/APP_ID
# or
- # projects/PROJECT_NUMBER/webApps/APP_ID
+ # projects/PROJECT_IDENTIFIER/webApps/APP_ID
+ # Refer to the `FirebaseProject`
+ # [`name`](../projects#FirebaseProject.FIELDS.name) field for details
+ # about PROJECT_IDENTIFIER values.
# Corresponds to the JSON property `app`
# @return [String]
attr_accessor :app
- # Applicable for Firebase Web Apps only.
- #
The unique Google-assigned identifier of the Google Analytics web
+ # Applicable for Firebase Web Apps only.
+ # The unique Google-assigned identifier of the Google Analytics web
# stream associated with the Firebase Web App. Firebase SDKs use this ID to
# interact with Google Analytics APIs.
- #
- #
Learn more about this ID and Google Analytics web streams in the
+ # Learn more about this ID and Google Analytics web streams in the
# [Analytics
# documentation](https://support.google.com/analytics/topic/9303475).
# Corresponds to the JSON property `measurementId`
@@ -1168,8 +1209,7 @@ module Google
# The unique Google-assigned identifier of the Google Analytics data stream
# associated with the Firebase App.
- #
- #
Learn more about Google Analytics data streams in the
+ # Learn more about Google Analytics data streams in the
# [Analytics
# documentation](https://support.google.com/analytics/answer/9303323).
# Corresponds to the JSON property `streamId`
@@ -1228,31 +1268,42 @@ module Google
class WebApp
include Google::Apis::Core::Hashable
- # Immutable. The globally unique, Firebase-assigned identifier of the App.
- #
- #
This identifier should be treated as an opaque token, as the data
+ # Immutable. The globally unique, Firebase-assigned identifier for the
+ # `WebApp`.
+ # This identifier should be treated as an opaque token, as the data
# format is not specified.
# Corresponds to the JSON property `appId`
# @return [String]
attr_accessor :app_id
- # The fully qualified URLs where the App is hosted.
+ # The URLs where the `WebApp` is hosted.
# Corresponds to the JSON property `appUrls`
# @return [Array]
attr_accessor :app_urls
- # The user-assigned display name of the App.
+ # The user-assigned display name for the `WebApp`.
# Corresponds to the JSON property `displayName`
# @return [String]
attr_accessor :display_name
- # The fully qualified resource name of the App, for example:
- #
projects/projectId/webApps/appId
+ # The resource name of the WebApp, in the format:
+ # projects/PROJECT_IDENTIFIER/webApps/APP_ID
+ # * PROJECT_IDENTIFIER: the parent Project's
+ # [`ProjectNumber`](../projects#FirebaseProject.FIELDS.project_number)
+ # ***(recommended)***
+ # or its [`ProjectId`](../projects#FirebaseProject.FIELDS.project_id).
+ # Learn more about using project identifiers in
+ # Google's [AIP 2510 standard](https://google.aip.dev/cloud/2510).
+ #
Note that the value for PROJECT_IDENTIFIER in any
+ # response body will be the `ProjectId`.
+ # * APP_ID: the globally unique, Firebase-assigned identifier
+ # for the App (see [`appId`](../projects.webApps#WebApp.FIELDS.app_id)).
# Corresponds to the JSON property `name`
# @return [String]
attr_accessor :name
- # The globally unique, user-assigned ID of the parent Project for the App.
+ # Immutable. A user-assigned unique identifier of the parent
+ # FirebaseProject for the `WebApp`.
# Corresponds to the JSON property `projectId`
# @return [String]
attr_accessor :project_id
@@ -1275,18 +1326,19 @@ module Google
class WebAppConfig
include Google::Apis::Core::Hashable
- # The API key associated with the web App.
+ # The API key associated with the `WebApp`.
# Corresponds to the JSON property `apiKey`
# @return [String]
attr_accessor :api_key
- # Immutable. The globally unique, Firebase-assigned identifier of the App.
+ # Immutable. The globally unique, Firebase-assigned identifier for the
+ # `WebApp`.
# Corresponds to the JSON property `appId`
# @return [String]
attr_accessor :app_id
# The domain Firebase Auth configures for OAuth redirects, in the format:
- #
projectId.firebaseapp.com
+ # PROJECT_ID.firebaseapp.com
# Corresponds to the JSON property `authDomain`
# @return [String]
attr_accessor :auth_domain
@@ -1296,14 +1348,14 @@ module Google
# @return [String]
attr_accessor :database_url
- # The ID of the project's default GCP resource location. The location is one
+ # The ID of the Project's default GCP resource location. The location is one
# of the available
# [GCP resource
- # locations](https://firebase.google.com/docs/projects/locations).
- #
This field is omitted if the default GCP resource location has not been
- # finalized yet. To set your project's default GCP resource location,
+ # locations](https://firebase.google.com/docs/projects/locations).
+ # This field is omitted if the default GCP resource location has not been
+ # finalized yet. To set a Project's default GCP resource location,
# call [`FinalizeDefaultLocation`](../projects.defaultLocation/finalize)
- # after you add Firebase services to your project.
+ # after you add Firebase resources to the Project.
# Corresponds to the JSON property `locationId`
# @return [String]
attr_accessor :location_id
@@ -1319,8 +1371,7 @@ module Google
# @return [String]
attr_accessor :messaging_sender_id
- # Immutable. The globally unique, user-assigned project ID of the parent
- # Project for the App.
+ # Immutable. A user-assigned unique identifier for the `FirebaseProject`.
# Corresponds to the JSON property `projectId`
# @return [String]
attr_accessor :project_id
diff --git a/generated/google/apis/firebase_v1beta1/service.rb b/generated/google/apis/firebase_v1beta1/service.rb
index f67149691..f53beefe9 100644
--- a/generated/google/apis/firebase_v1beta1/service.rb
+++ b/generated/google/apis/firebase_v1beta1/service.rb
@@ -48,30 +48,30 @@ module Google
@batch_path = 'batch'
end
- # Returns a list of [Google Cloud Platform (GCP) `Projects`]
+ # Lists each [Google Cloud Platform (GCP) `Project`]
# (https://cloud.google.com/resource-manager/reference/rest/v1/projects)
- # that are available to have Firebase resources added to them.
- #
- #
A GCP `Project` will only be returned if:
- #
- # The caller has sufficient
+ # that can have Firebase resources added to it.
+ # A Project will only be listed if:
+ #
+ # - The caller has sufficient
# [Google IAM](https://cloud.google.com/iam) permissions to call
- # AddFirebase.
- # The GCP `Project` is not already a FirebaseProject.
The GCP `Project` is not in an Organization which has policies
- # that prevent Firebase resources from being added.
+ # AddFirebase.
+ #
+ # The Project is not already a FirebaseProject.
+ #
+ # The Project is not in an Organization which has policies
+ # that prevent Firebase resources from being added.
+ #
+ #
# @param [Fixnum] page_size
- # The maximum number of GCP `Projects` to return in the response.
- #
- #
The server may return fewer than this value at its discretion.
+ # The maximum number of Projects to return in the response.
+ # The server may return fewer than this value at its discretion.
# If no value is specified (or too large a value is specified), the server
# will impose its own limit.
- #
- #
This value cannot be negative.
+ # This value cannot be negative.
# @param [String] page_token
# Token returned from a previous call to `ListAvailableProjects`
- # indicating where in the set of GCP `Projects` to resume listing.
+ # indicating where in the set of Projects to resume listing.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
@@ -135,12 +135,10 @@ module Google
# Adds Firebase resources to the specified existing
# [Google Cloud Platform (GCP) `Project`]
# (https://cloud.google.com/resource-manager/reference/rest/v1/projects).
- #
- #
Since a FirebaseProject is actually also a GCP `Project`, a
- # `FirebaseProject` uses underlying GCP identifiers (most importantly,
- # the `PROJECT_NUMBER`) as its own for easy interop with GCP APIs.
- #
- #
The result of this call is an [`Operation`](../../v1beta1/operations).
+ # Since a FirebaseProject is actually also a GCP `Project`, a
+ # `FirebaseProject` has the same underlying GCP identifiers (`projectNumber`
+ # and `projectId`). This allows for easy interop with Google APIs.
+ # The result of this call is an [`Operation`](../../v1beta1/operations).
# Poll the `Operation` to track the provisioning process by calling
# GetOperation until
# [`done`](../../v1beta1/operations#Operation.FIELDS.done) is `true`. When
@@ -152,11 +150,9 @@ module Google
# google.rpc.Status. The `Operation` is automatically deleted after
# completion, so there is no need to call
# DeleteOperation.
- #
- #
This method does not modify any billing account information on the
+ # This method does not modify any billing account information on the
# underlying GCP `Project`.
- #
- #
To call `AddFirebase`, a project member or service account must have
+ # To call `AddFirebase`, a project member or service account must have
# the following permissions (the IAM roles of Editor and Owner contain these
# permissions):
# `firebase.projects.update`, `resourcemanager.projects.get`,
@@ -164,11 +160,18 @@ module Google
# @param [String] project
# The resource name of the GCP `Project` to which Firebase resources will be
# added, in the format:
- #
projects/PROJECT_NUMBER
- # After calling `AddFirebase`, the
- # [`project_id`](https://cloud.google.com/resource-manager/reference/rest/v1/
- # projects#Project.FIELDS.project_id)
- # of the GCP `Project` is also the `project_id` of the FirebaseProject.
+ # projects/PROJECT_IDENTIFIER
+ # Refer to the `FirebaseProject`
+ # [`name`](../projects#FirebaseProject.FIELDS.name) field for details
+ # about PROJECT_IDENTIFIER values.
+ # After calling `AddFirebase`, the unique Project identifiers (
+ # [`projectNumber`](https://cloud.google.com/resource-manager/reference/rest/v1/
+ # projects#Project.FIELDS.project_number)
+ # and
+ # [`projectId`](https://cloud.google.com/resource-manager/reference/rest/v1/
+ # projects#Project.FIELDS.project_id))
+ # of the underlying GCP `Project` are also the identifiers of the
+ # FirebaseProject.
# @param [Google::Apis::FirebaseV1beta1::AddFirebaseRequest] add_firebase_request_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
@@ -199,38 +202,35 @@ module Google
execute_or_queue_command(command, &block)
end
- # Links a FirebaseProject with an existing
+ # Links the specified FirebaseProject with an existing
# [Google Analytics account](http://www.google.com/analytics/).
- #
- #
Using this call, you can either:
+ # Using this call, you can either:
#
# - Specify an `analyticsAccountId` to provision a new Google Analytics
# property within the specified account and associate the new property with
- # your `FirebaseProject`.
+ # the `FirebaseProject`.
# - Specify an existing `analyticsPropertyId` to associate the property
- # with your `FirebaseProject`.
+ # with the `FirebaseProject`.
#
- #
# Note that when you call `AddGoogleAnalytics`:
#
# - The first check determines if any existing data streams in the
- # Google Analytics property correspond to any existing Firebase Apps in your
- # `FirebaseProject` (based on the `packageName` or `bundleId` associated with
- # the data stream). Then, as applicable, the data streams and apps are
- # linked. Note that this auto-linking only applies to Android Apps and iOS
- # Apps.
- # - If no corresponding data streams are found for your Firebase Apps,
- # new data streams are provisioned in the Google Analytics property
- # for each of your Firebase Apps. Note that a new data stream is always
- # provisioned for a Web App even if it was previously associated with a
- # data stream in your Analytics property.
+ # Google Analytics property correspond to any existing Firebase Apps in the
+ # `FirebaseProject` (based on the `packageName` or `bundleId` associated
+ # with the data stream). Then, as applicable, the data streams and apps are
+ # linked. Note that this auto-linking only applies to `AndroidApps` and
+ # `IosApps`.
+ # - If no corresponding data streams are found for the Firebase Apps, new
+ # data streams are provisioned in the Google Analytics property for each of
+ # the Firebase Apps. Note that a new data stream is always provisioned for
+ # a Web App even if it was previously associated with a data stream in the
+ # Analytics property.
#
# Learn more about the hierarchy and structure of Google Analytics
# accounts in the
# [Analytics
# documentation](https://support.google.com/analytics/answer/9303323).
- #
- #
The result of this call is an [`Operation`](../../v1beta1/operations).
+ # The result of this call is an [`Operation`](../../v1beta1/operations).
# Poll the `Operation` to track the provisioning process by calling
# GetOperation until
# [`done`](../../v1beta1/operations#Operation.FIELDS.done) is `true`. When
@@ -240,22 +240,23 @@ module Google
# an AnalyticsDetails; if the `Operation` failed, its
# [`error`](../../v1beta1/operations#Operation.FIELDS.error) is set to a
# google.rpc.Status.
- #
- #
To call `AddGoogleAnalytics`, a member must be an Owner for
+ # To call `AddGoogleAnalytics`, a project member must be an Owner for
# the existing `FirebaseProject` and have the
# [`Edit` permission](https://support.google.com/analytics/answer/2884495)
# for the Google Analytics account.
- #
- #
If a `FirebaseProject` already has Google Analytics enabled, and you
+ # If the `FirebaseProject` already has Google Analytics enabled, and you
# call `AddGoogleAnalytics` using an `analyticsPropertyId` that's different
# from the currently associated property, then the call will fail. Analytics
# may have already been enabled in the Firebase console or by specifying
# `timeZone` and `regionCode` in the call to
# [`AddFirebase`](../../v1beta1/projects/addFirebase).
# @param [String] parent
- # The parent `FirebaseProject` to link to an existing Google Analytics
- # account, in the format:
- #
projects/PROJECT_NUMBER
+ # The resource name of the FirebaseProject to link to an existing Google
+ # Analytics account, in the format:
+ # projects/PROJECT_IDENTIFIER
+ # Refer to the `FirebaseProject`
+ # [`name`](../projects#FirebaseProject.FIELDS.name) field for details
+ # about PROJECT_IDENTIFIER values.
# @param [Google::Apis::FirebaseV1beta1::AddGoogleAnalyticsRequest] add_google_analytics_request_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
@@ -286,10 +287,13 @@ module Google
execute_or_queue_command(command, &block)
end
- # Gets the FirebaseProject identified by the specified resource name.
+ # Gets the specified FirebaseProject.
# @param [String] name
- # The fully qualified resource name of the Project, in the format:
- #
projects/PROJECT_NUMBER
+ # The resource name of the FirebaseProject, in the format:
+ # projects/PROJECT_IDENTIFIER
+ # Refer to the `FirebaseProject`
+ # [`name`](../projects#FirebaseProject.FIELDS.name) field for details
+ # about PROJECT_IDENTIFIER values.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
@@ -317,15 +321,19 @@ module Google
execute_or_queue_command(command, &block)
end
- # Gets the configuration artifact used by servers to simplify initialization.
- #
- #
Typically, this configuration is used with the Firebase Admin SDK
+ # Gets the configuration artifact associated with the specified
+ # FirebaseProject, which can be used by servers to simplify
+ # initialization.
+ # Typically, this configuration is used with the Firebase Admin SDK
# [initializeApp](https://firebase.google.com/docs/admin/setup#
# initialize_the_sdk)
# command.
# @param [String] name
- # The fully qualified resource name of the Project, in the format:
- #
projects/PROJECT_NUMBER/adminSdkConfig
+ # The resource name of the FirebaseProject, in the format:
+ # projects/PROJECT_IDENTIFIER/adminSdkConfig
+ # Refer to the `FirebaseProject`
+ # [`name`](../projects#FirebaseProject.FIELDS.name) field for details
+ # about PROJECT_IDENTIFIER values.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
@@ -353,14 +361,16 @@ module Google
execute_or_queue_command(command, &block)
end
- # Gets the Google Analytics details currently associated with a
+ # Gets the Google Analytics details currently associated with the specified
# FirebaseProject.
- #
- #
If the `FirebaseProject` is not yet linked to Google Analytics, then
- # the response to `GetAnalyticsDetails` is NOT_FOUND.
+ # If the `FirebaseProject` is not yet linked to Google Analytics, then
+ # the response to `GetAnalyticsDetails` is `NOT_FOUND`.
# @param [String] name
- # The fully qualified resource name, in the format:
- #
projects/PROJECT_NUMBER/analyticsDetails
+ # The resource name of the FirebaseProject, in the format:
+ # projects/PROJECT_IDENTIFIER/analyticsDetails
+ # Refer to the `FirebaseProject`
+ # [`name`](../projects#FirebaseProject.FIELDS.name) field for details
+ # about PROJECT_IDENTIFIER values.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
@@ -389,27 +399,22 @@ module Google
end
# Lists each FirebaseProject accessible to the caller.
- #
- #
The elements are returned in no particular order, but they will be a
+ # The elements are returned in no particular order, but they will be a
# consistent view of the Projects when additional requests are made with a
# `pageToken`.
- #
- #
This method is eventually consistent with Project mutations, which
+ # This method is eventually consistent with Project mutations, which
# means newly provisioned Projects and recent modifications to existing
# Projects might not be reflected in the set of Projects. The list will
# include only ACTIVE Projects.
- #
- #
Use
+ # Use
# GetFirebaseProject
# for consistent reads as well as for additional Project details.
# @param [Fixnum] page_size
# The maximum number of Projects to return in the response.
- #
- #
The server may return fewer than this at its discretion.
+ # The server may return fewer than this at its discretion.
# If no value is specified (or too large a value is specified), the server
# will impose its own limit.
- #
- #
This value cannot be negative.
+ # This value cannot be negative.
# @param [String] page_token
# Token returned from a previous call to `ListFirebaseProjects` indicating
# where in the set of Projects to resume listing.
@@ -441,19 +446,24 @@ module Google
execute_or_queue_command(command, &block)
end
- # Updates the attributes of the FirebaseProject identified by the
- # specified resource name.
- #
- #
All [query parameters](#query-parameters) are required.
+ # Updates the attributes of the specified FirebaseProject.
+ # All [query parameters](#query-parameters) are required.
# @param [String] name
- # The fully qualified resource name of the Project, in the format:
- #
projects/projectId
+ # The resource name of the Project, in the format:
+ # projects/PROJECT_IDENTIFIER
+ # PROJECT_IDENTIFIER: the Project's
+ # [`ProjectNumber`](../projects#FirebaseProject.FIELDS.project_number)
+ # ***(recommended)***
+ # or its [`ProjectId`](../projects#FirebaseProject.FIELDS.project_id).
+ #
Learn more about using project identifiers in
+ # Google's [AIP 2510 standard](https://google.aip.dev/cloud/2510).
+ #
Note that the value for PROJECT_IDENTIFIER in any
+ # response body will be the `ProjectId`.
# @param [Google::Apis::FirebaseV1beta1::FirebaseProject] firebase_project_object
# @param [String] update_mask
# Specifies which fields to update.
- #
- #
If this list is empty, then no state will be updated.
- #
Note that the fields `name`, `project_id`, and `project_number` are all
+ # If this list is empty, then no state will be updated.
+ # Note that the fields `name`, `projectId`, and `projectNumber` are all
# immutable.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
@@ -485,27 +495,27 @@ module Google
execute_or_queue_command(command, &block)
end
- # Unlinks the specified `FirebaseProject` from its Google Analytics account.
- #
- #
This call removes the association of the specified `FirebaseProject`
+ # Unlinks the specified FirebaseProject from its Google Analytics
+ # account.
+ # This call removes the association of the specified `FirebaseProject`
# with its current Google Analytics property. However, this call does not
# delete the Google Analytics resources, such as the Google Analytics
# property or any data streams.
- #
- #
These resources may be re-associated later to the `FirebaseProject` by
+ # These resources may be re-associated later to the `FirebaseProject` by
# calling
# [`AddGoogleAnalytics`](../../v1beta1/projects/addGoogleAnalytics) and
# specifying the same `analyticsPropertyId`. For Android Apps and iOS Apps,
# this call re-links data streams with their corresponding apps. However,
- # for Web Apps, this call provisions a new data stream for each Web
- # App.
- #
- #
To call `RemoveAnalytics`, a member must be an Owner for
+ # for Web Apps, this call provisions a *new* data stream for each Web App.
+ # To call `RemoveAnalytics`, a project member must be an Owner for
# the `FirebaseProject`.
# @param [String] parent
- # The parent `FirebaseProject` to unlink from its Google Analytics account,
- # in the format:
- #
projects/PROJECT_NUMBER
+ # The resource name of the FirebaseProject to unlink from its Google
+ # Analytics account, in the format:
+ # projects/PROJECT_IDENTIFIER
+ # Refer to the `FirebaseProject`
+ # [`name`](../projects#FirebaseProject.FIELDS.name) field for details
+ # about PROJECT_IDENTIFIER values.
# @param [Google::Apis::FirebaseV1beta1::RemoveAnalyticsRequest] remove_analytics_request_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
@@ -536,23 +546,22 @@ module Google
execute_or_queue_command(command, &block)
end
- # A convenience method that lists all available Apps for the specified
- # FirebaseProject.
- #
- #
Typically, interaction with an App should be done using the
- # platform-specific service, but some tool use-cases require a summary of all
- # known Apps (such as for App selector interfaces).
+ # Lists all available Apps for the specified FirebaseProject.
+ # This is a convenience method. Typically, interaction with an App should
+ # be done using the platform-specific service, but some tool use-cases
+ # require a summary of all known Apps (such as for App selector interfaces).
# @param [String] parent
- # The parent Project for which to list Apps, in the format:
- #
projects/PROJECT_NUMBER
+ # The parent FirebaseProject for which to list Apps, in the format:
+ # projects/PROJECT_IDENTIFIER
+ # Refer to the `FirebaseProject`
+ # [`name`](../projects#FirebaseProject.FIELDS.name) field for details
+ # about PROJECT_IDENTIFIER values.
# @param [Fixnum] page_size
# The maximum number of Apps to return in the response.
- #
- #
The server may return fewer than this value at its discretion.
+ # The server may return fewer than this value at its discretion.
# If no value is specified (or too large a value is specified), then the
# server will impose its own limit.
- #
- #
This value cannot be negative.
+ # This value cannot be negative.
# @param [String] page_token
# Token returned from a previous call to `SearchFirebaseApps` indicating
# where in the set of Apps to resume listing.
@@ -585,14 +594,18 @@ module Google
execute_or_queue_command(command, &block)
end
- # Requests that a new AndroidApp be created.
- #
- #
The result of this call is an `Operation` which can be used to track
+ # Requests the creation of a new AndroidApp in the specified
+ # FirebaseProject.
+ # The result of this call is an `Operation` which can be used to track
# the provisioning process. The `Operation` is automatically deleted after
# completion, so there is no need to call `DeleteOperation`.
# @param [String] parent
- # The parent Project in which to create an App, in the format:
- #
projects/PROJECT_NUMBER
+ # The resource name of the parent FirebaseProject in which to create an
+ # AndroidApp, in the format:
+ # projects/PROJECT_IDENTIFIER/androidApps
+ # Refer to the `FirebaseProject`
+ # [`name`](../projects#FirebaseProject.FIELDS.name) field for details
+ # about PROJECT_IDENTIFIER values.
# @param [Google::Apis::FirebaseV1beta1::AndroidApp] android_app_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
@@ -623,14 +636,19 @@ module Google
execute_or_queue_command(command, &block)
end
- # Gets the AndroidApp identified by the specified resource name.
+ # Gets the specified AndroidApp.
# @param [String] name
- # The fully qualified resource name of the App, in the format:
- #
projects/PROJECT_NUMBER/androidApps/APP_IDprojects/PROJECT_IDENTIFIER/androidApps/APP_ID
- #
As an APP_ID is a unique identifier, the Unique Resource
+ #
+ # Since an APP_ID is a unique identifier, the Unique Resource
# from Sub-Collection access pattern may be used here, in the format:
- #
projects/-/androidApps/APP_ID
+ # projects/-/androidApps/APP_ID
+ #
+ # Refer to the `AndroidApp`
+ # [`name`](../projects.androidApps#AndroidApp.FIELDS.name) field for details
+ # about PROJECT_IDENTIFIER and APP_ID values.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
@@ -661,12 +679,18 @@ module Google
# Gets the configuration artifact associated with the specified
# AndroidApp.
# @param [String] name
- # The resource name of the App configuration to download, in the format:
- #
projects/PROJECT_NUMBER/androidApps/APP_ID/
+ # The resource name of the AndroidApp configuration to download, in the
+ # format:
+ # projects/PROJECT_IDENTIFIER/androidApps/APP_ID/
# config
- #
As an APP_ID is a unique identifier, the Unique Resource
+ #
+ # Since an APP_ID is a unique identifier, the Unique Resource
# from Sub-Collection access pattern may be used here, in the format:
- #
projects/-/androidApps/APP_ID
+ # projects/-/androidApps/APP_ID
+ #
+ # Refer to the `AndroidApp`
+ # [`name`](../projects.androidApps#AndroidApp.FIELDS.name) field for details
+ # about PROJECT_IDENTIFIER and APP_ID values.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
@@ -694,18 +718,21 @@ module Google
execute_or_queue_command(command, &block)
end
- # Lists each AndroidApp associated with the specified parent Project.
- #
- #
The elements are returned in no particular order, but will be a
+ # Lists each AndroidApp associated with the specified
+ # FirebaseProject.
+ # The elements are returned in no particular order, but will be a
# consistent view of the Apps when additional requests are made with a
# `pageToken`.
# @param [String] parent
- # The parent Project for which to list Apps, in the format:
- #
projects/PROJECT_NUMBER
+ # The resource name of the parent FirebaseProject for which to list each
+ # associated AndroidApp, in the format:
+ # projects/PROJECT_IDENTIFIER/androidApps
+ # Refer to the `FirebaseProject`
+ # [`name`](../projects#FirebaseProject.FIELDS.name) field for details
+ # about PROJECT_IDENTIFIER values.
# @param [Fixnum] page_size
# The maximum number of Apps to return in the response.
- #
- #
The server may return fewer than this at its discretion.
+ # The server may return fewer than this at its discretion.
# If no value is specified (or too large a value is specified), then the
# server will impose its own limit.
# @param [String] page_token
@@ -740,15 +767,26 @@ module Google
execute_or_queue_command(command, &block)
end
- # Updates the attributes of the AndroidApp identified by the specified
- # resource name.
+ # Updates the attributes of the specified AndroidApp.
# @param [String] name
- # The fully qualified resource name of the App, in the format:
- #
projects/projectId/androidApps/appId
+ # The resource name of the AndroidApp, in the format:
+ # projects/PROJECT_IDENTIFIER/androidApps/APP_ID
+ # * PROJECT_IDENTIFIER: the parent Project's
+ # [`ProjectNumber`](../projects#FirebaseProject.FIELDS.project_number)
+ # ***(recommended)***
+ # or its [`ProjectId`](../projects#FirebaseProject.FIELDS.project_id).
+ # Learn more about using project identifiers in
+ # Google's [AIP 2510 standard](https://google.aip.dev/cloud/2510).
+ #
Note that the value for PROJECT_IDENTIFIER in any
+ # response body will be the `ProjectId`.
+ # * APP_ID: the globally unique, Firebase-assigned identifier
+ # for the App
+ # (see [`appId`](../projects.androidApps#AndroidApp.FIELDS.app_id)).
# @param [Google::Apis::FirebaseV1beta1::AndroidApp] android_app_object
# @param [String] update_mask
# Specifies which fields to update.
- #
Note that the fields `name`, `app_id`, `project_id`, and `package_name`
+ # Note that the fields `name`, `app_id`, `project_id`, and `package_name`
# are all immutable.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
@@ -780,14 +818,20 @@ module Google
execute_or_queue_command(command, &block)
end
- # Adds a SHA certificate to the specified AndroidApp.
+ # Adds a ShaCertificate to the specified AndroidApp.
# @param [String] parent
- # The parent App to which a SHA certificate will be added, in the format:
- #
projects/PROJECT_NUMBER/androidApps/APP_IDprojects/PROJECT_IDENTIFIER/androidApps/APP_ID
- #
As an APP_ID is a unique identifier, the Unique Resource
+ #
+ # Since an APP_ID is a unique identifier, the Unique Resource
# from Sub-Collection access pattern may be used here, in the format:
- #
projects/-/androidApps/APP_ID
+ # projects/-/androidApps/APP_ID
+ #
+ # Refer to the `AndroidApp`
+ # [`name`](../projects.androidApps#AndroidApp.FIELDS.name) field for details
+ # about PROJECT_IDENTIFIER and APP_ID values.
# @param [Google::Apis::FirebaseV1beta1::ShaCertificate] sha_certificate_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
@@ -818,14 +862,19 @@ module Google
execute_or_queue_command(command, &block)
end
- # Removes a SHA certificate from the specified AndroidApp.
+ # Removes a ShaCertificate from the specified AndroidApp.
# @param [String] name
- # The fully qualified resource name of the `sha-key`, in the format:
- #
projects/PROJECT_NUMBER/androidApps/APP_ID/sha/
- # SHA_ID
- #
You can obtain the full name from the response of
- # [`ListShaCertificates`](../projects.androidApps.sha/list) or the original
- # [`CreateShaCertificate`](../projects.androidApps.sha/create).
+ # The resource name of the ShaCertificate to remove from the parent
+ # AndroidApp, in the format:
+ # projects/PROJECT_IDENTIFIER/androidApps/APP_ID/sha/
+ # SHA_HASH
+ # Refer to the `ShaCertificate`
+ # [`name`](../projects.androidApps.sha#ShaCertificate.FIELDS.name) field for
+ # details about PROJECT_IDENTIFIER, APP_ID, and
+ # SHA_HASH values.
+ # You can obtain the full resource name of the `ShaCertificate` from the
+ # response of [`ListShaCertificates`](../projects.androidApps.sha/list) or
+ # the original [`CreateShaCertificate`](../projects.androidApps.sha/create).
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
@@ -853,15 +902,20 @@ module Google
execute_or_queue_command(command, &block)
end
- # Returns the list of SHA-1 and SHA-256 certificates for the specified
- # AndroidApp.
+ # Lists the SHA-1 and SHA-256 certificates for the specified AndroidApp.
# @param [String] parent
- # The parent App for which to list SHA certificates, in the format:
- #
projects/PROJECT_NUMBER/androidApps/APP_IDprojects/PROJECT_IDENTIFIER/androidApps/APP_ID
- #
As an APP_ID is a unique identifier, the Unique Resource
+ #
+ # Since an APP_ID is a unique identifier, the Unique Resource
# from Sub-Collection access pattern may be used here, in the format:
- #
projects/-/androidApps/APP_ID
+ # projects/-/androidApps/APP_ID
+ #
+ # Refer to the `AndroidApp`
+ # [`name`](../projects.androidApps#AndroidApp.FIELDS.name) field for details
+ # about PROJECT_IDENTIFIER and APP_ID values.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
@@ -889,41 +943,42 @@ module Google
execute_or_queue_command(command, &block)
end
- # Returns a list of valid Google Cloud Platform (GCP) resource locations for
+ # Lists the valid Google Cloud Platform (GCP) resource locations for
# the specified Project (including a FirebaseProject).
- #
- #
One of these locations can be selected as the Project's [_default_ GCP
+ # One of these locations can be selected as the Project's [_default_ GCP
# resource location](https://firebase.google.com/docs/projects/locations),
- # which is the geographical location where project resources, such as Cloud
- # Firestore, will be provisioned by default. However, if the default GCP
- # resource location has already been set for the Project, then this setting
- # cannot be changed.
- #
- #
This call checks for any possible
+ # which is the geographical location where the Project's resources, such as
+ # Cloud Firestore, will be provisioned by default. However, if the default
+ # GCP resource location has already been set for the Project, then this
+ # setting cannot be changed.
+ # This call checks for any possible
# [location
# restrictions](https://cloud.google.com/resource-manager/docs/organization-
# policy/defining-locations)
# for the specified Project and, thus, might return a subset of all possible
# GCP resource locations. To list all GCP resource locations (regardless of
- # any restrictions), call the endpoint without specifying a `PROJECT_NUMBER`
- # (that is, `/v1beta1/`parent=projects/-`/listAvailableLocations`).
- #
To call `ListAvailableLocations` with a specified project, a member
- # must be at minimum a Viewer of the project. Calls without a specified
- # project do not require any specific project permissions.
+ # any restrictions), call the endpoint without specifying a unique project
+ # identifier (that is,
+ # `/v1beta1/`parent=projects/-`/listAvailableLocations`).
+ # To call `ListAvailableLocations` with a specified project, a member must be
+ # at minimum a Viewer of the Project. Calls without a specified project do
+ # not require any specific project permissions.
# @param [String] parent
- # The Project for which to list GCP resource locations, in the format:
- #
projects/PROJECT_NUMBER
- #
If no project is specified (that is, `projects/-`), the returned list
- # does not take into account org-specific or project-specific location
- # restrictions.
+ # The FirebaseProject for which to list GCP resource locations,
+ # in the format:
+ # projects/PROJECT_IDENTIFIER
+ # Refer to the `FirebaseProject`
+ # [`name`](../projects#FirebaseProject.FIELDS.name) field for details
+ # about PROJECT_IDENTIFIER values.
+ # If no unique project identifier is specified (that is, `projects/-`),
+ # the returned list does not take into account org-specific or
+ # project-specific location restrictions.
# @param [Fixnum] page_size
# The maximum number of locations to return in the response.
- #
- #
The server may return fewer than this value at its discretion.
+ # The server may return fewer than this value at its discretion.
# If no value is specified (or too large a value is specified), then the
# server will impose its own limit.
- #
- #
This value cannot be negative.
+ # This value cannot be negative.
# @param [String] page_token
# Token returned from a previous call to `ListAvailableLocations` indicating
# where in the list of locations to resume listing.
@@ -958,31 +1013,28 @@ module Google
# Sets the default Google Cloud Platform (GCP) resource location for the
# specified FirebaseProject.
- #
- #
This method creates an App Engine application with a
+ # This method creates an App Engine application with a
# [default Cloud Storage
# bucket](https://cloud.google.com/appengine/docs/standard/python/
# googlecloudstorageclient/setting-up-cloud-storage#
# activating_a_cloud_storage_bucket),
# located in the specified
- # [`location_id`](#body.request_body.FIELDS.location_id).
+ # [`locationId`](#body.request_body.FIELDS.location_id).
# This location must be one of the available
# [GCP resource
- # locations](https://firebase.google.com/docs/projects/locations).
- #
After the default GCP resource location is finalized, or if it was
+ # locations](https://firebase.google.com/docs/projects/locations).
+ # After the default GCP resource location is finalized, or if it was
# already set, it cannot be changed. The default GCP resource location for
- # the specified FirebaseProject might already be set because either the
- # GCP `Project` already has an App Engine application or
+ # the specified `FirebaseProject` might already be set because either the
+ # underlying GCP `Project` already has an App Engine application or
# `FinalizeDefaultLocation` was previously called with a specified
- # `location_id`. Any new calls to `FinalizeDefaultLocation` with a
- # different specified `location_id` will return a 409 error.
- #
- #
The result of this call is an [`Operation`](../../v1beta1/operations),
+ # `locationId`. Any new calls to `FinalizeDefaultLocation` with a
+ # *different* specified `locationId` will return a 409 error.
+ # The result of this call is an [`Operation`](../../v1beta1/operations),
# which can be used to track the provisioning process. The
# [`response`](../../v1beta1/operations#Operation.FIELDS.response) type of
# the `Operation` is google.protobuf.Empty.
- #
- #
The `Operation` can be polled by its `name` using
+ # The `Operation` can be polled by its `name` using
# GetOperation until `done` is
# true. When `done` is true, the `Operation` has either succeeded or failed.
# If the `Operation` has succeeded, its
@@ -991,15 +1043,16 @@ module Google
# `error` will be set to a google.rpc.Status. The `Operation` is
# automatically deleted after completion, so there is no need to call
# DeleteOperation.
- #
- #
All fields listed in the [request body](#request-body) are required.
- #
- #
To call `FinalizeDefaultLocation`, a member must be an Owner
- # of the project.
+ # All fields listed in the [request body](#request-body) are required.
+ # To call `FinalizeDefaultLocation`, a member must be an Owner
+ # of the Project.
# @param [String] parent
- # The resource name of the Project for which the default GCP resource
- # location will be set, in the format:
- #
projects/PROJECT_NUMBER
+ # The resource name of the FirebaseProject for which the default GCP
+ # resource location will be set, in the format:
+ # projects/PROJECT_IDENTIFIER
+ # Refer to the `FirebaseProject`
+ # [`name`](../projects#FirebaseProject.FIELDS.name) field for details
+ # about PROJECT_IDENTIFIER values.
# @param [Google::Apis::FirebaseV1beta1::FinalizeDefaultLocationRequest] finalize_default_location_request_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
@@ -1030,14 +1083,18 @@ module Google
execute_or_queue_command(command, &block)
end
- # Requests that a new IosApp be created.
- #
- #
The result of this call is an `Operation` which can be used to track
+ # Requests the creation of a new IosApp in the specified
+ # FirebaseProject.
+ # The result of this call is an `Operation` which can be used to track
# the provisioning process. The `Operation` is automatically deleted after
# completion, so there is no need to call `DeleteOperation`.
# @param [String] parent
- # The parent Project in which to create an App, in the format:
- #
projects/PROJECT_NUMBER
+ # The resource name of the parent FirebaseProject in which to create an
+ # IosApp, in the format:
+ # projects/PROJECT_IDENTIFIER/iosApps
+ # Refer to the `FirebaseProject`
+ # [`name`](../projects#FirebaseProject.FIELDS.name) field for details
+ # about PROJECT_IDENTIFIER values.
# @param [Google::Apis::FirebaseV1beta1::IosApp] ios_app_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
@@ -1068,13 +1125,18 @@ module Google
execute_or_queue_command(command, &block)
end
- # Gets the IosApp identified by the specified resource name.
+ # Gets the specified IosApp.
# @param [String] name
- # The fully qualified resource name of the App, in the format:
- # projects/PROJECT_NUMBER/iosApps/APP_ID
- #
As an APP_ID is a unique identifier, the Unique Resource
+ # The resource name of the IosApp, in the format:
+ # projects/PROJECT_IDENTIFIER/iosApps/APP_ID
+ #
+ # Since an APP_ID is a unique identifier, the Unique Resource
# from Sub-Collection access pattern may be used here, in the format:
- #
projects/-/iosApps/APP_ID
+ # projects/-/iosApps/APP_ID
+ #
+ # Refer to the `IosApp`
+ # [`name`](../projects.iosApps#IosApp.FIELDS.name) field for details
+ # about PROJECT_IDENTIFIER and APP_ID values.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
@@ -1105,11 +1167,16 @@ module Google
# Gets the configuration artifact associated with the specified IosApp.
# @param [String] name
# The resource name of the App configuration to download, in the format:
- #
projects/PROJECT_NUMBER/iosApps/APP_ID/configprojects/PROJECT_IDENTIFIER/iosApps/APP_ID/config
- #
As an APP_ID is a unique identifier, the Unique Resource
+ #
+ # Since an APP_ID is a unique identifier, the Unique Resource
# from Sub-Collection access pattern may be used here, in the format:
- #
projects/-/iosApps/APP_ID
+ # projects/-/iosApps/APP_ID
+ #
+ # Refer to the `IosApp`
+ # [`name`](../projects.iosApps#IosApp.FIELDS.name) field for details
+ # about PROJECT_IDENTIFIER and APP_ID values.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
@@ -1137,18 +1204,20 @@ module Google
execute_or_queue_command(command, &block)
end
- # Lists each IosApp associated with the specified parent Project.
- #
- #
The elements are returned in no particular order, but will be a
+ # Lists each IosApp associated with the specified FirebaseProject.
+ # The elements are returned in no particular order, but will be a
# consistent view of the Apps when additional requests are made with a
# `pageToken`.
# @param [String] parent
- # The parent Project for which to list Apps, in the format:
- #
projects/PROJECT_NUMBER
+ # The resource name of the parent FirebaseProject for which to list each
+ # associated IosApp, in the format:
+ # projects/PROJECT_IDENTIFIER/iosApps
+ # Refer to the `FirebaseProject`
+ # [`name`](../projects#FirebaseProject.FIELDS.name) field for details
+ # about PROJECT_IDENTIFIER values.
# @param [Fixnum] page_size
# The maximum number of Apps to return in the response.
- #
- #
The server may return fewer than this at its discretion.
+ # The server may return fewer than this at its discretion.
# If no value is specified (or too large a value is specified), the server
# will impose its own limit.
# @param [String] page_token
@@ -1183,15 +1252,24 @@ module Google
execute_or_queue_command(command, &block)
end
- # Updates the attributes of the IosApp identified by the specified
- # resource name.
+ # Updates the attributes of the specified IosApp.
# @param [String] name
- # The fully qualified resource name of the App, in the format:
- #
projects/projectId/iosApps/appId
+ # The resource name of the IosApp, in the format:
+ # projects/PROJECT_IDENTIFIER/iosApps/APP_ID
+ # * PROJECT_IDENTIFIER: the parent Project's
+ # [`ProjectNumber`](../projects#FirebaseProject.FIELDS.project_number)
+ # ***(recommended)***
+ # or its [`ProjectId`](../projects#FirebaseProject.FIELDS.project_id).
+ # Learn more about using project identifiers in
+ # Google's [AIP 2510 standard](https://google.aip.dev/cloud/2510).
+ #
Note that the value for PROJECT_IDENTIFIER in any
+ # response body will be the `ProjectId`.
+ # * APP_ID: the globally unique, Firebase-assigned identifier
+ # for the App (see [`appId`](../projects.iosApps#IosApp.FIELDS.app_id)).
# @param [Google::Apis::FirebaseV1beta1::IosApp] ios_app_object
# @param [String] update_mask
# Specifies which fields to update.
- #
Note that the fields `name`, `appId`, `projectId`, and `bundleId`
+ # Note that the fields `name`, `appId`, `projectId`, and `bundleId`
# are all immutable.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
@@ -1223,14 +1301,18 @@ module Google
execute_or_queue_command(command, &block)
end
- # Requests that a new WebApp be created.
- #
- #
The result of this call is an `Operation` which can be used to track
+ # Requests the creation of a new WebApp in the specified
+ # FirebaseProject.
+ # The result of this call is an `Operation` which can be used to track
# the provisioning process. The `Operation` is automatically deleted after
# completion, so there is no need to call `DeleteOperation`.
# @param [String] parent
- # The parent Project in which to create an App, in the format:
- #
projects/PROJECT_NUMBER
+ # The resource name of the parent FirebaseProject in which to create a
+ # WebApp, in the format:
+ # projects/PROJECT_IDENTIFIER/webApps
+ # Refer to the `FirebaseProject`
+ # [`name`](../projects#FirebaseProject.FIELDS.name) field for details
+ # about PROJECT_IDENTIFIER values.
# @param [Google::Apis::FirebaseV1beta1::WebApp] web_app_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
@@ -1261,13 +1343,18 @@ module Google
execute_or_queue_command(command, &block)
end
- # Gets the WebApp identified by the specified resource name.
+ # Gets the specified WebApp.
# @param [String] name
- # The fully qualified resource name of the App, in the format:
- #
projects/PROJECT_NUMBER/webApps/APP_ID
- #
As an APP_ID is a unique identifier, the Unique Resource
+ # The resource name of the WebApp, in the format:
+ # projects/PROJECT_IDENTIFIER/webApps/APP_ID
+ #
+ # Since an APP_ID is a unique identifier, the Unique Resource
# from Sub-Collection access pattern may be used here, in the format:
- #
projects/-/webApps/APP_ID
+ # projects/-/webApps/APP_ID
+ #
+ # Refer to the `WebApp`
+ # [`name`](../projects.webApps#WebApp.FIELDS.name) field for details
+ # about PROJECT_IDENTIFIER and APP_ID values.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
@@ -1297,12 +1384,18 @@ module Google
# Gets the configuration artifact associated with the specified WebApp.
# @param [String] name
- # The resource name of the App configuration to download, in the format:
- #
projects/PROJECT_NUMBER/webApps/APP_ID/configprojects/PROJECT_IDENTIFIER/webApps/APP_ID/config
- #
As an APP_ID is a unique identifier, the Unique Resource
+ #
+ # Since an APP_ID is a unique identifier, the Unique Resource
# from Sub-Collection access pattern may be used here, in the format:
- #
projects/-/webApps/APP_ID
+ # projects/-/webApps/APP_ID
+ #
+ # Refer to the `WebApp`
+ # [`name`](../projects.webApps#WebApp.FIELDS.name) field for details
+ # about PROJECT_IDENTIFIER and APP_ID values.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
@@ -1330,18 +1423,20 @@ module Google
execute_or_queue_command(command, &block)
end
- # Lists each WebApp associated with the specified parent Project.
- #
- #
The elements are returned in no particular order, but will be a
+ # Lists each WebApp associated with the specified FirebaseProject.
+ # The elements are returned in no particular order, but will be a
# consistent view of the Apps when additional requests are made with a
# `pageToken`.
# @param [String] parent
- # The parent Project for which to list Apps, in the format:
- #
projects/PROJECT_NUMBER
+ # The resource name of the parent FirebaseProject for which to list each
+ # associated WebApp, in the format:
+ # projects/PROJECT_IDENTIFIER/webApps
+ # Refer to the `FirebaseProject`
+ # [`name`](../projects#FirebaseProject.FIELDS.name) field for details
+ # about PROJECT_IDENTIFIER values.
# @param [Fixnum] page_size
# The maximum number of Apps to return in the response.
- #
- #
The server may return fewer than this value at its discretion.
+ # The server may return fewer than this value at its discretion.
# If no value is specified (or too large a value is specified), then the
# server will impose its own limit.
# @param [String] page_token
@@ -1376,16 +1471,24 @@ module Google
execute_or_queue_command(command, &block)
end
- # Updates the attributes of the WebApp identified by the specified
- # resource name.
+ # Updates the attributes of the specified WebApp.
# @param [String] name
- # The fully qualified resource name of the App, for example:
- #
projects/projectId/webApps/appId
+ # The resource name of the WebApp, in the format:
+ # projects/PROJECT_IDENTIFIER/webApps/APP_ID
+ # * PROJECT_IDENTIFIER: the parent Project's
+ # [`ProjectNumber`](../projects#FirebaseProject.FIELDS.project_number)
+ # ***(recommended)***
+ # or its [`ProjectId`](../projects#FirebaseProject.FIELDS.project_id).
+ # Learn more about using project identifiers in
+ # Google's [AIP 2510 standard](https://google.aip.dev/cloud/2510).
+ #
Note that the value for PROJECT_IDENTIFIER in any
+ # response body will be the `ProjectId`.
+ # * APP_ID: the globally unique, Firebase-assigned identifier
+ # for the App (see [`appId`](../projects.webApps#WebApp.FIELDS.app_id)).
# @param [Google::Apis::FirebaseV1beta1::WebApp] web_app_object
# @param [String] update_mask
# Specifies which fields to update.
- #
Note that the fields `name`, `appId`, and `projectId` are all
- # immutable.
+ # Note that the fields `name`, `appId`, and `projectId` are all immutable.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
diff --git a/generated/google/apis/fitness_v1.rb b/generated/google/apis/fitness_v1.rb
index 361278f51..e6592508b 100644
--- a/generated/google/apis/fitness_v1.rb
+++ b/generated/google/apis/fitness_v1.rb
@@ -25,7 +25,7 @@ module Google
# @see https://developers.google.com/fit/rest/v1/get-started
module FitnessV1
VERSION = 'V1'
- REVISION = '20200601'
+ REVISION = '20200724'
# Use Google Fit to see and store your physical activity data
AUTH_FITNESS_ACTIVITY_READ = 'https://www.googleapis.com/auth/fitness.activity.read'
diff --git a/generated/google/apis/storagetransfer_v1.rb b/generated/google/apis/storagetransfer_v1.rb
index 0688c9501..2667e0d58 100644
--- a/generated/google/apis/storagetransfer_v1.rb
+++ b/generated/google/apis/storagetransfer_v1.rb
@@ -26,7 +26,7 @@ module Google
# @see https://cloud.google.com/storage-transfer/docs
module StoragetransferV1
VERSION = 'V1'
- REVISION = '20200605'
+ REVISION = '20200721'
# View and manage your data across Google Cloud Platform services
AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform'
diff --git a/generated/google/apis/storagetransfer_v1/service.rb b/generated/google/apis/storagetransfer_v1/service.rb
index 1ef06a0fd..365111395 100644
--- a/generated/google/apis/storagetransfer_v1/service.rb
+++ b/generated/google/apis/storagetransfer_v1/service.rb
@@ -236,8 +236,32 @@ module Google
execute_or_queue_command(command, &block)
end
- # Cancels a transfer. Use the get method to check whether the cancellation
- # succeeded or whether the operation completed despite cancellation.
+ # Cancels a transfer. Use the
+ # transferOperations.get method to
+ # check if the cancellation succeeded or if the operation completed despite
+ # the `cancel` request.
+ # When you cancel an operation, the currently running transfer is
+ # interrupted. For recurring transfer jobs, the next instance of the transfer
+ # job
+ # will still run. For example, if your job is configured to run every day
+ # at 1pm and you cancel Monday's operation at 1:05pm, Monday's transfer
+ # will stop. However, a transfer job will still be attempted on Tuesday.
+ # This applies only to currently running operations. If an operation is
+ # not currently running, `cancel` does nothing.
+ #
+ # When you cancel a job, the next job computes a delta of files and may repair
+ # any
+ # inconsistent state. For instance, if you run a job every day, and today's job
+ # found 10 new files and transferred five files before you canceled the job,
+ # tomorrow's transfer operation will compute a new delta with the five files
+ # that
+ # were not copied today plus any new files discovered tomorrow.
# @param [String] name
# The name of the operation resource to be cancelled.
# @param [String] fields
diff --git a/generated/google/apis/youtube_partner_v1.rb b/generated/google/apis/youtube_partner_v1.rb
index 024a01eaa..7cb10cccb 100644
--- a/generated/google/apis/youtube_partner_v1.rb
+++ b/generated/google/apis/youtube_partner_v1.rb
@@ -26,7 +26,7 @@ module Google
# @see https://devsite.googleplex.com/youtube/partner/docs/v1/
module YoutubePartnerV1
VERSION = 'V1'
- REVISION = '20200724'
+ REVISION = '20200727'
# View and manage your assets and associated content on YouTube
AUTH_YOUTUBEPARTNER = 'https://www.googleapis.com/auth/youtubepartner'
diff --git a/generated/google/apis/youtube_partner_v1/service.rb b/generated/google/apis/youtube_partner_v1/service.rb
index 5e1972820..8b3875b78 100644
--- a/generated/google/apis/youtube_partner_v1/service.rb
+++ b/generated/google/apis/youtube_partner_v1/service.rb
@@ -347,7 +347,7 @@ module Google
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
- def list_asset_relationships(asset_id: nil, on_behalf_of_content_owner: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
+ def list_asset_relationships(asset_id, on_behalf_of_content_owner: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'youtube/partner/v1/assetRelationships', options)
command.response_representation = Google::Apis::YoutubePartnerV1::AssetRelationshipListResponse::Representation
command.response_class = Google::Apis::YoutubePartnerV1::AssetRelationshipListResponse
@@ -489,7 +489,7 @@ module Google
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
- def list_asset_shares(asset_id: nil, on_behalf_of_content_owner: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
+ def list_asset_shares(asset_id, on_behalf_of_content_owner: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'youtube/partner/v1/assetShares', options)
command.response_representation = Google::Apis::YoutubePartnerV1::AssetShareListResponse::Representation
command.response_class = Google::Apis::YoutubePartnerV1::AssetShareListResponse
@@ -600,6 +600,16 @@ module Google
# duplicate assets have been merged, the API response only contains the
# synthesized asset. (It does not contain the constituent assets that were
# merged into the synthesized asset.)
+ # @param [String] id
+ # The *id* parameter specifies a comma-separated list of YouTube Asset IDs that
+ # identify the assets you want to retrieve. As noted in the method description,
+ # if you try to retrieve an asset that YouTube identified as a duplicate and
+ # merged with another asset, the API response only returns the synthesized asset.
+ # In that case, the aliasId property in the asset resource specifies a list of
+ # other asset IDs that can be used to identify that asset. Also note that the
+ # API response does not contain duplicates. As such, if your request identifies
+ # three asset IDs, and all of those have been merged into a single asset, then
+ # the API response identifies one matching asset.
# @param [String] fetch_match_policy
# The *fetchMatchPolicy* parameter specifies the version of the asset's match
# policy that should be returned in the API response.
@@ -615,16 +625,6 @@ module Google
# @param [Boolean] fetch_ownership_conflicts
# The *fetchOwnershipConflicts* parameter allows you to retrieve information
# about ownership conflicts.
- # @param [String] id
- # The *id* parameter specifies a comma-separated list of YouTube Asset IDs that
- # identify the assets you want to retrieve. As noted in the method description,
- # if you try to retrieve an asset that YouTube identified as a duplicate and
- # merged with another asset, the API response only returns the synthesized asset.
- # In that case, the aliasId property in the asset resource specifies a list of
- # other asset IDs that can be used to identify that asset. Also note that the
- # API response does not contain duplicates. As such, if your request identifies
- # three asset IDs, and all of those have been merged into a single asset, then
- # the API response identifies one matching asset.
# @param [String] on_behalf_of_content_owner
# The *onBehalfOfContentOwner* parameter identifies the content owner that the
# user is acting on behalf of. This parameter supports users whose accounts are
@@ -646,7 +646,7 @@ module Google
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
- def list_assets(fetch_match_policy: nil, fetch_metadata: nil, fetch_ownership: nil, fetch_ownership_conflicts: nil, id: nil, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, options: nil, &block)
+ def list_assets(id, fetch_match_policy: nil, fetch_metadata: nil, fetch_ownership: nil, fetch_ownership_conflicts: nil, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'youtube/partner/v1/assets', options)
command.response_representation = Google::Apis::YoutubePartnerV1::AssetListResponse::Representation
command.response_class = Google::Apis::YoutubePartnerV1::AssetListResponse
@@ -1403,10 +1403,10 @@ module Google
end
# Inserts a cuepoint into a live broadcast.
- # @param [Google::Apis::YoutubePartnerV1::LiveCuepoint] live_cuepoint_object
# @param [String] channel_id
# The *channelId* parameter identifies the channel that owns the broadcast into
# which the cuepoint is being inserted.
+ # @param [Google::Apis::YoutubePartnerV1::LiveCuepoint] live_cuepoint_object
# @param [String] on_behalf_of_content_owner
# The *onBehalfOfContentOwner* parameter identifies the content owner that the
# user is acting on behalf of. This parameter supports users whose accounts are
@@ -1430,7 +1430,7 @@ module Google
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
- def insert_live_cuepoint(live_cuepoint_object = nil, channel_id: nil, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, options: nil, &block)
+ def insert_live_cuepoint(channel_id, live_cuepoint_object = nil, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'youtube/partner/v1/liveCuepoints', options)
command.request_representation = Google::Apis::YoutubePartnerV1::LiveCuepoint::Representation
command.request_object = live_cuepoint_object
@@ -1469,7 +1469,7 @@ module Google
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
- def list_metadata_histories(asset_id: nil, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, options: nil, &block)
+ def list_metadata_histories(asset_id, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'youtube/partner/v1/metadataHistory', options)
command.response_representation = Google::Apis::YoutubePartnerV1::MetadataHistoryListResponse::Representation
command.response_class = Google::Apis::YoutubePartnerV1::MetadataHistoryListResponse
@@ -1635,7 +1635,7 @@ module Google
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
- def list_ownership_histories(asset_id: nil, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, options: nil, &block)
+ def list_ownership_histories(asset_id, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'youtube/partner/v1/ownershipHistory', options)
command.response_representation = Google::Apis::YoutubePartnerV1::OwnershipHistoryListResponse::Representation
command.response_class = Google::Apis::YoutubePartnerV1::OwnershipHistoryListResponse