fix: add https://www.googleapis.com/auth/analytics.edit OAuth2 scope to the list of acceptable scopes for all read only methods of the Admin API docs: update the documentation of the update_mask` field used by Update() methods (#81)

PiperOrigin-RevId: 359531616

Source-Author: Google APIs <noreply@google.com>
Source-Date: Thu Feb 25 08:46:37 2021 -0800
Source-Repo: googleapis/googleapis
Source-Sha: 2a9e7295e6fe864d0a748ff5a7c44d2da6e6d15a
Source-Link: googleapis/googleapis@2a9e729

Author: yoshi-automation

protos/google/analytics/admin/v1alpha/analytics_admin.proto

@@ -1,4 +1,4 @@
-// Copyright 2020 Google LLC
+// Copyright 2021 Google LLC
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.
@@ -358,7 +358,15 @@ service AnalyticsAdminService {
     option (google.api.method_signature) = "ios_app_data_stream,update_mask";
   }
 
-  // Creates an iOS app data stream with the specified location and attributes.
+  // Creates an iOS app stream with the specified location and attributes.
+  //
+  // Note that an iOS app stream must be linked to a Firebase app to receive
+  // traffic.
+  //
+  // To create a working app stream, make sure your property is linked to a
+  // Firebase project. Then, use the Firebase API to create a Firebase app,
+  // which will also create an appropriate data stream in Analytics (may take up
+  // to 24 hours).
   rpc CreateIosAppDataStream(CreateIosAppDataStreamRequest) returns (IosAppDataStream) {
     option (google.api.http) = {
       post: "/v1alpha/{parent=properties/*}/iosAppDataStreams"
@@ -403,7 +411,15 @@ service AnalyticsAdminService {
     option (google.api.method_signature) = "android_app_data_stream,update_mask";
   }
 
-  // Creates an android app stream with the specified location and attributes.
+  // Creates an Android app stream with the specified location and attributes.
+  //
+  // Note that an Android app stream must be linked to a Firebase app to receive
+  // traffic.
+  //
+  // To create a working app stream, make sure your property is linked to a
+  // Firebase project. Then, use the Firebase API to create a Firebase app,
+  // which will also create an appropriate data stream in Analytics (may take up
+  // to 24 hours).
   rpc CreateAndroidAppDataStream(CreateAndroidAppDataStreamRequest) returns (AndroidAppDataStream) {
     option (google.api.http) = {
       post: "/v1alpha/{parent=properties/*}/androidAppDataStreams"
@@ -596,9 +612,9 @@ message UpdateAccountRequest {
   // The account's `name` field is used to identify the account.
   Account account = 1 [(google.api.field_behavior) = REQUIRED];
 
-  // Required. The list of fields to be updated. Omitted fields will not be updated.
-  // To replace the entire entity, use one path with the string "*" to match
-  // all fields.
+  // Required. The list of fields to be updated. Field names must be in snake case
+  // (e.g., "field_to_update"). Omitted fields will not be updated. To replace
+  // the entire entity, use one path with the string "*" to match all fields.
   google.protobuf.FieldMask update_mask = 2 [(google.api.field_behavior) = REQUIRED];
 }
 
@@ -683,9 +699,9 @@ message UpdatePropertyRequest {
   // updated.
   Property property = 1 [(google.api.field_behavior) = REQUIRED];
 
-  // Required. The list of fields to be updated. Omitted fields will not be updated.
-  // To replace the entire entity, use one path with the string "*" to match
-  // all fields.
+  // Required. The list of fields to be updated. Field names must be in snake case
+  // (e.g., "field_to_update"). Omitted fields will not be updated. To replace
+  // the entire entity, use one path with the string "*" to match all fields.
   google.protobuf.FieldMask update_mask = 2 [(google.api.field_behavior) = REQUIRED];
 }
 
@@ -962,9 +978,9 @@ message UpdateWebDataStreamRequest {
   // The `name` field is used to identify the web stream to be updated.
   WebDataStream web_data_stream = 1 [(google.api.field_behavior) = REQUIRED];
 
-  // Required. The list of fields to be updated. Omitted fields will not be updated.
-  // To replace the entire entity, use one path with the string "*" to match
-  // all fields.
+  // Required. The list of fields to be updated. Field names must be in snake case
+  // (e.g., "field_to_update"). Omitted fields will not be updated. To replace
+  // the entire entity, use one path with the string "*" to match all fields.
   google.protobuf.FieldMask update_mask = 2 [(google.api.field_behavior) = REQUIRED];
 }
 
@@ -1049,9 +1065,9 @@ message UpdateIosAppDataStreamRequest {
   // The `name` field is used to identify the iOS app stream to be updated.
   IosAppDataStream ios_app_data_stream = 1 [(google.api.field_behavior) = REQUIRED];
 
-  // Required. The list of fields to be updated. Omitted fields will not be updated.
-  // To replace the entire entity, use one path with the string "*" to match
-  // all fields.
+  // Required. The list of fields to be updated. Field names must be in snake case
+  // (e.g., "field_to_update"). Omitted fields will not be updated. To replace
+  // the entire entity, use one path with the string "*" to match all fields.
   google.protobuf.FieldMask update_mask = 2 [(google.api.field_behavior) = REQUIRED];
 }
 
@@ -1136,9 +1152,9 @@ message UpdateAndroidAppDataStreamRequest {
   // The `name` field is used to identify the android app stream to be updated.
   AndroidAppDataStream android_app_data_stream = 1 [(google.api.field_behavior) = REQUIRED];
 
-  // Required. The list of fields to be updated. Omitted fields will not be updated.
-  // To replace the entire entity, use one path with the string "*" to match
-  // all fields.
+  // Required. The list of fields to be updated. Field names must be in snake case
+  // (e.g., "field_to_update"). Omitted fields will not be updated. To replace
+  // the entire entity, use one path with the string "*" to match all fields.
   google.protobuf.FieldMask update_mask = 2 [(google.api.field_behavior) = REQUIRED];
 }
 
@@ -1213,9 +1229,9 @@ message UpdateEnhancedMeasurementSettingsRequest {
   // The `name` field is used to identify the settings to be updated.
   EnhancedMeasurementSettings enhanced_measurement_settings = 1 [(google.api.field_behavior) = REQUIRED];
 
-  // Required. The list of fields to be updated. Omitted fields will not be updated.
-  // To replace the entire entity, use one path with the string "*" to match
-  // all fields.
+  // Required. The list of fields to be updated. Field names must be in snake case
+  // (e.g., "field_to_update"). Omitted fields will not be updated. To replace
+  // the entire entity, use one path with the string "*" to match all fields.
   google.protobuf.FieldMask update_mask = 2 [(google.api.field_behavior) = REQUIRED];
 }
 
@@ -1239,9 +1255,9 @@ message UpdateFirebaseLinkRequest {
   // Required. The Firebase link to update.
   FirebaseLink firebase_link = 1 [(google.api.field_behavior) = REQUIRED];
 
-  // Required. The list of fields to be updated. Omitted fields will not be updated.
-  // To replace the entire entity, use one path with the string "*" to match
-  // all fields.
+  // Required. The list of fields to be updated. Field names must be in snake case
+  // (e.g., "field_to_update"). Omitted fields will not be updated. To replace
+  // the entire entity, use one path with the string "*" to match all fields.
   google.protobuf.FieldMask update_mask = 2 [(google.api.field_behavior) = REQUIRED];
 }
 
@@ -1326,9 +1342,9 @@ message UpdateGoogleAdsLinkRequest {
   // The GoogleAdsLink to update
   GoogleAdsLink google_ads_link = 1;
 
-  // Required. The list of fields to be updated. Omitted fields will not be updated.
-  // To replace the entire entity, use one path with the string "*" to match
-  // all fields.
+  // Required. The list of fields to be updated. Field names must be in snake case
+  // (e.g., "field_to_update"). Omitted fields will not be updated. To replace
+  // the entire entity, use one path with the string "*" to match all fields.
   google.protobuf.FieldMask update_mask = 2 [(google.api.field_behavior) = REQUIRED];
 }
 

protos/google/analytics/admin/v1alpha/resources.proto

@@ -1,4 +1,4 @@
-// Copyright 2020 Google LLC
+// Copyright 2021 Google LLC
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.

src/v1alpha/analytics_admin_service_client.ts

@@ -683,9 +683,9 @@ export class AnalyticsAdminServiceClient {
    *   Required. The account to update.
    *   The account's `name` field is used to identify the account.
    * @param {google.protobuf.FieldMask} request.updateMask
-   *   Required. The list of fields to be updated. Omitted fields will not be updated.
-   *   To replace the entire entity, use one path with the string "*" to match
-   *   all fields.
+   *   Required. The list of fields to be updated. Field names must be in snake case
+   *   (e.g., "field_to_update"). Omitted fields will not be updated. To replace
+   *   the entire entity, use one path with the string "*" to match all fields.
    * @param {object} [options]
    *   Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
    * @returns {Promise} - The promise which resolves to an array.
@@ -1163,9 +1163,9 @@ export class AnalyticsAdminServiceClient {
    *   The property's `name` field is used to identify the property to be
    *   updated.
    * @param {google.protobuf.FieldMask} request.updateMask
-   *   Required. The list of fields to be updated. Omitted fields will not be updated.
-   *   To replace the entire entity, use one path with the string "*" to match
-   *   all fields.
+   *   Required. The list of fields to be updated. Field names must be in snake case
+   *   (e.g., "field_to_update"). Omitted fields will not be updated. To replace
+   *   the entire entity, use one path with the string "*" to match all fields.
    * @param {object} [options]
    *   Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
    * @returns {Promise} - The promise which resolves to an array.
@@ -2264,9 +2264,9 @@ export class AnalyticsAdminServiceClient {
    *   Required. The web stream to update.
    *   The `name` field is used to identify the web stream to be updated.
    * @param {google.protobuf.FieldMask} request.updateMask
-   *   Required. The list of fields to be updated. Omitted fields will not be updated.
-   *   To replace the entire entity, use one path with the string "*" to match
-   *   all fields.
+   *   Required. The list of fields to be updated. Field names must be in snake case
+   *   (e.g., "field_to_update"). Omitted fields will not be updated. To replace
+   *   the entire entity, use one path with the string "*" to match all fields.
    * @param {object} [options]
    *   Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
    * @returns {Promise} - The promise which resolves to an array.
@@ -2672,9 +2672,9 @@ export class AnalyticsAdminServiceClient {
    *   Required. The iOS app stream to update.
    *   The `name` field is used to identify the iOS app stream to be updated.
    * @param {google.protobuf.FieldMask} request.updateMask
-   *   Required. The list of fields to be updated. Omitted fields will not be updated.
-   *   To replace the entire entity, use one path with the string "*" to match
-   *   all fields.
+   *   Required. The list of fields to be updated. Field names must be in snake case
+   *   (e.g., "field_to_update"). Omitted fields will not be updated. To replace
+   *   the entire entity, use one path with the string "*" to match all fields.
    * @param {object} [options]
    *   Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
    * @returns {Promise} - The promise which resolves to an array.
@@ -2771,7 +2771,15 @@ export class AnalyticsAdminServiceClient {
     >
   ): void;
   /**
-   * Creates an iOS app data stream with the specified location and attributes.
+   * Creates an iOS app stream with the specified location and attributes.
+   *
+   * Note that an iOS app stream must be linked to a Firebase app to receive
+   * traffic.
+   *
+   * To create a working app stream, make sure your property is linked to a
+   * Firebase project. Then, use the Firebase API to create a Firebase app,
+   * which will also create an appropriate data stream in Analytics (may take up
+   * to 24 hours).
    *
    * @param {Object} request
    *   The request object that will be sent.
@@ -3092,9 +3100,9 @@ export class AnalyticsAdminServiceClient {
    *   Required. The android app stream to update.
    *   The `name` field is used to identify the android app stream to be updated.
    * @param {google.protobuf.FieldMask} request.updateMask
-   *   Required. The list of fields to be updated. Omitted fields will not be updated.
-   *   To replace the entire entity, use one path with the string "*" to match
-   *   all fields.
+   *   Required. The list of fields to be updated. Field names must be in snake case
+   *   (e.g., "field_to_update"). Omitted fields will not be updated. To replace
+   *   the entire entity, use one path with the string "*" to match all fields.
    * @param {object} [options]
    *   Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
    * @returns {Promise} - The promise which resolves to an array.
@@ -3191,7 +3199,15 @@ export class AnalyticsAdminServiceClient {
     >
   ): void;
   /**
-   * Creates an android app stream with the specified location and attributes.
+   * Creates an Android app stream with the specified location and attributes.
+   *
+   * Note that an Android app stream must be linked to a Firebase app to receive
+   * traffic.
+   *
+   * To create a working app stream, make sure your property is linked to a
+   * Firebase project. Then, use the Firebase API to create a Firebase app,
+   * which will also create an appropriate data stream in Analytics (may take up
+   * to 24 hours).
    *
    * @param {Object} request
    *   The request object that will be sent.
@@ -3413,9 +3429,9 @@ export class AnalyticsAdminServiceClient {
    *   Required. The settings to update.
    *   The `name` field is used to identify the settings to be updated.
    * @param {google.protobuf.FieldMask} request.updateMask
-   *   Required. The list of fields to be updated. Omitted fields will not be updated.
-   *   To replace the entire entity, use one path with the string "*" to match
-   *   all fields.
+   *   Required. The list of fields to be updated. Field names must be in snake case
+   *   (e.g., "field_to_update"). Omitted fields will not be updated. To replace
+   *   the entire entity, use one path with the string "*" to match all fields.
    * @param {object} [options]
    *   Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
    * @returns {Promise} - The promise which resolves to an array.
@@ -3623,9 +3639,9 @@ export class AnalyticsAdminServiceClient {
    * @param {google.analytics.admin.v1alpha.FirebaseLink} request.firebaseLink
    *   Required. The Firebase link to update.
    * @param {google.protobuf.FieldMask} request.updateMask
-   *   Required. The list of fields to be updated. Omitted fields will not be updated.
-   *   To replace the entire entity, use one path with the string "*" to match
-   *   all fields.
+   *   Required. The list of fields to be updated. Field names must be in snake case
+   *   (e.g., "field_to_update"). Omitted fields will not be updated. To replace
+   *   the entire entity, use one path with the string "*" to match all fields.
    * @param {object} [options]
    *   Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
    * @returns {Promise} - The promise which resolves to an array.
@@ -4026,9 +4042,9 @@ export class AnalyticsAdminServiceClient {
    * @param {google.analytics.admin.v1alpha.GoogleAdsLink} request.googleAdsLink
    *   The GoogleAdsLink to update
    * @param {google.protobuf.FieldMask} request.updateMask
-   *   Required. The list of fields to be updated. Omitted fields will not be updated.
-   *   To replace the entire entity, use one path with the string "*" to match
-   *   all fields.
+   *   Required. The list of fields to be updated. Field names must be in snake case
+   *   (e.g., "field_to_update"). Omitted fields will not be updated. To replace
+   *   the entire entity, use one path with the string "*" to match all fields.
    * @param {object} [options]
    *   Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
    * @returns {Promise} - The promise which resolves to an array.

synth.metadata

@@ -4,15 +4,15 @@
       "git": {
         "name": ".",
         "remote": "https://github.com/googleapis/nodejs-analytics-admin.git",
-        "sha": "a264ca93f5ef4d53df02ae3ce632566e4f17764e"
+        "sha": "8242432db044fbf0f51c1b45ecdbf91bf2311aaa"
       }
     },
     {
       "git": {
         "name": "googleapis",
         "remote": "https://github.com/googleapis/googleapis.git",
-        "sha": "23e7356f4cf449d6e9977698c5d9383b566be7af",
-        "internalRef": "351651504"
+        "sha": "2a9e7295e6fe864d0a748ff5a7c44d2da6e6d15a",
+        "internalRef": "359531616"
       }
     },
     {