@google-cloud/nodejs-common 0.9.9-alpha → 1.0.3-alpha

package/bin/install_functions.sh

@@ -443,7 +443,7 @@ select_functions_location() {
 "name~${PROJECT_NAMESPACE}" --format="csv[no-heading](name,REGION)"))
     if [[ ${#exist_functions[@]} -gt 0 ]]; then
       local exist_region
-      exist_region=$(printf "${exist_functions[0]}" | cut -d, -f2 | uniq)
+      exist_region=$(printf "${exist_functions[0]}" | cut -d\, -f2 | uniq)
       printf '%s\n' "Current application has already been installed in region: \
 ${exist_region}."
       local i
@@ -466,9 +466,9 @@ Functions for that region. Do you want to continue? [N/y]: "
         if [[ ${confirm_delete} == "Y" || ${confirm_delete} == "y" ]]; then
           for i in "${!exist_functions[@]}"; do
             local exist_function
-            exist_function=$(printf "${exist_functions[$i]}" | cut -d, -f1)
+            exist_function=$(printf "${exist_functions[$i]}" | cut -d\, -f1)
             local function_region
-            function_region=$(printf "${exist_functions[$i]}" | cut -d, -f2)
+            function_region=$(printf "${exist_functions[$i]}" | cut -d\, -f2)
             gcloud functions delete --region="${function_region}" \
 "${exist_function}"
           done
@@ -1818,31 +1818,66 @@ get_cloud_functions_service_account() {
 }
 
 #######################################
-# Make sure Firestore or Datastore is in the current project.
-# To create the Firestore, the operator need to have following permissions:
-# appengine.applications.create - role: Owner
-# datastore.locations.list - sample role: Cloud Datastore Owner
-# servicemanagement.services.bind - sample role: Editor
+# Make sure the Firestore database is in the current project. If there is no
+# Firestore datastore, it will help to create one.
+# To create the Firestore, the operator need to be the Owner.
 # Globals:
 #   GCP_PROJECT
 # Arguments:
-#   None.
+#   Firestore mode, 'native' or 'datastore'.
+#   Firestore region, it's not the same list as Cloud Functions regions and it
+#   will be bonded to this Cloud project after created.
 #######################################
 check_firestore_existence() {
-  gcloud firestore indexes fields list >/dev/null 2>&1
-  while [[ $? -gt 0 ]]; do
-    cat <<EOF
-Cannot find Firestore or Datastore in current project. Please visit \
-https://console.cloud.google.com/firestore?project=${GCP_PROJECT} to create a \
-database before continue.
-
-Press any key to continue after you create the database...
-EOF
+  local firestore mode appRegion
+  mode="${1}"
+  appRegion="${2}"
+  firestore=$(gcloud app describe --format="csv[no-heading](databaseType)")
+  if [[ -z "${firestore}" ]]; then
+    printf '%s\n' "Firestore is not ready. Creating a new Firestore database\
+is an irreversible operation, so read carefully before continue:"
+    printf '%s\n' "  1. You need to be the owner of ${GCP_PROJECT} to continue."
+    printf '%s\n' "  2. Once you select the region and mode, you cannot change it."
+    printf '%s\n' "Press any key to continue..."
     local any
     read -n1 -s any
-    printf '\n'
-    gcloud firestore indexes fields list >/dev/null 2>&1
-  done
+    if [[ -z "${mode}" ]]; then
+      printf '%s\n' "  For more information about mode, see \
+https://cloud.google.com/firestore/docs/firestore-or-datastore#choosing_a_database_mode"
+    fi
+    while [[ -z "${mode}" ]]; do
+      printf '%s' "  Enter the mode of your dataset [Native]: "
+      local selectMode
+      read -r selectMode
+      selectMode=$(printf '%s' "${selectMode:-"Native"}" | \
+        tr '[:upper:]' '[:lower:]')
+      if [[ ${selectMode} == 'native' || ${selectMode} == 'datastore' ]]; then
+        mode=${selectMode}
+      fi
+    done
+    printf '%s\n' "Creating Firestore database in ${mode} mode..."
+    gcloud app create --region=${appRegion}
+    if [[ $? -eq 0 ]]; then
+      if [[ "${mode}" == "native" ]]; then
+        appRegion=$(gcloud app describe --format="csv[no-heading](locationId)")
+        gcloud firestore databases create --region="${appRegion}"
+      fi
+    else
+      return 1
+    fi
+  else
+    printf '%s\n' "OK. Firestore is ready in mode ${firestore}."
+  fi
+}
+
+#######################################
+# Installation step for confirming Firestore is ready.
+# See function check_firestore_existence.
+#######################################
+confirm_firestore() {
+  (( STEP += 1 ))
+  printf '%s\n' "Step ${STEP}: Checking the status of Firestore..."
+  check_firestore_existence "$@"
 }
 
 #######################################
@@ -1875,3 +1910,27 @@ join_string_array() {
   shift
   printf %s "$first" "${@/#/$separator}"
 }
+
+#######################################
+# Creates or updates the BigQuery view.
+# Globals:
+#  GCP_PROJECT
+#  DATASET
+# Arguments:
+#  The name of view.
+#  The query of view.
+#######################################
+create_or_update_view() {
+  local viewName viewQuery
+  viewName="${1}"
+  viewQuery="${2}"
+  local action="mk"
+  if [[ $(check_existence_in_bigquery "${DATASET}.${viewName}") -eq 0 ]]; then
+    action="update"
+  fi
+  bq "${action}" \
+    --use_legacy_sql=false \
+    --view "${viewQuery}" \
+    --project_id ${GCP_PROJECT} \
+    "${DATASET}.${viewName}"
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@google-cloud/nodejs-common",
-  "version": "0.9.9-alpha",
+  "version": "1.0.3-alpha",
   "description": "A NodeJs common library for solutions based on Cloud Functions",
   "author": "Google Inc.",
   "license": "Apache-2.0",

package/src/apis/google_ads.js

@@ -80,6 +80,13 @@ const IDENTIFIERS = [
   'address_info',
 ];
 
+/**
+ * Maximum number of user identifiers in single UserData.
+ * @see https://ads-developers.googleblog.com/2021/10/userdata-enforcement-in-google-ads-api.html
+ * @type {number}
+ */
+const MAX_IDENTIFIERS_PER_USER = 20;
+
 /**
  * Configuration for uploading click conversions for Google Ads, includes:
  * gclid, conversion_action, conversion_date_time, conversion_value,
@@ -139,15 +146,11 @@ let CustomerMatchConfig;
  * hashed_email, hashed_phone_number, mobile_id, third_party_user_id or address_info
  * @see https://developers.google.com/google-ads/api/reference/rpc/latest/UserIdentifier
  * @typedef {{
- *   hashed_email: string,
- * }|{
- *   hashed_phone_number: string,
- * }|{
- *   mobile_id: string,
- * }|{
- *   third_party_user_id: string,
- * }|{
- *   address_info: GoogleAdsApi.OfflineUserAddressInfo,
+ *   hashed_email: (string|Array<string>|undefined),
+ *   hashed_phone_number: (string|Array<string>|undefined),
+ *   mobile_id: (string|Array<string>|undefined),
+ *   third_party_user_id: (string|Array<string>|undefined),
+ *   address_info: (GoogleAdsApi.OfflineUserAddressInfo|undefined),
  * }}
  */
 let CustomerMatchRecord;
@@ -530,18 +533,17 @@ class GoogleAds {
     const customerId = customerMatchConfig.customer_id.replace(/-/g, '');
     const loginCustomerId = customerMatchConfig.login_customer_id.replace(/-/g,
         '');
-    const userListType = customerMatchConfig.list_type;
     const userListId = customerMatchConfig.list_id;
     const operation = customerMatchConfig.operation;
 
     const customer = this.getGoogleAdsApiCustomer_(loginCustomerId, customerId);
     const operationsList = this.buildOperationsList_(operation,
-        customerMatchRecords, userListType);
+        customerMatchRecords);
     const metadata = this.buildCustomerMatchUserListMetadata_(customerId,
         userListId);
     const request = UploadUserDataRequest.create({
       customer_id: customerId,
-      operations: [operationsList],
+      operations: operationsList,
       customer_match_user_list_metadata: metadata,
     });
     const response = await customer.userData.uploadUserData(request);
@@ -556,18 +558,36 @@ class GoogleAds {
    * @see https://developers.google.com/google-ads/api/reference/rpc/latest/UserDataOperation
    * @param {string} operationType either 'create' or 'remove'
    * @param {Array<CustomerMatchRecord>} customerMatchRecords userIds
-   * @param {string} userListType One of the following hashed_email, hashed_phone_number,
-   *     mobile_id, third_party_user_id or address_info
    * @return {Array<UserDataOperation>}
    * @private
    */
-  buildOperationsList_(operationType, customerMatchRecords, userListType) {
-    const userIdentifiers = customerMatchRecords.map((customerMatchRecord) => {
-      return UserIdentifier.create(
-          {[userListType]: customerMatchRecord[userListType]});
+  buildOperationsList_(operationType, customerMatchRecords) {
+    return customerMatchRecords.map((customerMatchRecord) => {
+      const userIdentifiers = [];
+      IDENTIFIERS.forEach((idType) => {
+        const idValue = customerMatchRecord[idType];
+        if (idValue) {
+          if (Array.isArray(idValue)) {
+            idValue.forEach((user) => {
+              userIdentifiers.push(UserIdentifier.create({[idType]: user}));
+            });
+          } else {
+            userIdentifiers.push(UserIdentifier.create({[idType]: idValue}));
+          }
+        }
+      });
+      let userData;
+      if (userIdentifiers.length <= MAX_IDENTIFIERS_PER_USER) {
+        userData = UserData.create({user_identifiers: userIdentifiers});
+      } else {
+        this.logger.warn(
+            `Too many user identifiers, will only send ${MAX_IDENTIFIERS_PER_USER}:`,
+            JSON.stringify(customerMatchRecord));
+        userData = UserData.create({user_identifiers: userIdentifiers}.slice(0,
+            MAX_IDENTIFIERS_PER_USER));
+      }
+      return UserDataOperation.create({[operationType]: userData});
     });
-    const userData = UserData.create({user_identifiers: userIdentifiers});
-    return UserDataOperation.create({[operationType]: userData});
   }
 
   /**

package/src/apis/index.js

@@ -88,7 +88,7 @@ exports.bigquery = require('./bigquery.js');
  * APIs integration class for Google Ads.
  * @const {{
  *   GoogleAds:!GoogleAds,
- *   ClickConversionConfig:!ClickConversionConfig,
+ *   ConversionConfig:!ConversionConfig,
  *   CustomerMatchConfig: !CustomerMatchConfig,
  *   CustomerMatchRecord: !CustomerMatchRecord,
  *   ReportQueryConfig:!ReportQueryConfig,