@google-cloud/nodejs-common 2.2.2 → 2.3.1

package/src/apis/google_ads.js

@@ -1,1145 +0,0 @@
-// Copyright 2019 Google Inc.
-//
-// Licensed under the Apache License, Version 2.0 (the "License");
-// you may not use this file except in compliance with the License.
-// You may obtain a copy of the License at
-//
-//      http://www.apache.org/licenses/LICENSE-2.0
-//
-// Unless required by applicable law or agreed to in writing, software
-// distributed under the License is distributed on an "AS IS" BASIS,
-// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-// See the License for the specific language governing permissions and
-// limitations under the License.
-
-/**
- * @fileoverview Google Ads API (unofficial) Wrapper.
- */
-'use strict';
-
-const {protos: {google: {ads: {googleads}}}} = require('google-ads-node');
-const googleAdsLib = googleads[Object.keys(googleads)[0]];
-const {
-  common: {
-    CustomerMatchUserListMetadata,
-    StoreSalesMetadata,
-    TransactionAttribute,
-    UserAttribute,
-    UserData,
-    UserIdentifier,
-  },
-  resources: {
-    GoogleAdsField,
-    OfflineUserDataJob,
-    UserList,
-  },
-  services: {
-    AddOfflineUserDataJobOperationsRequest,
-    CreateOfflineUserDataJobRequest,
-    RunOfflineUserDataJobRequest,
-    SearchGoogleAdsFieldsRequest,
-    UploadCallConversionsRequest,
-    UploadCallConversionsResponse,
-    UploadClickConversionsRequest,
-    UploadClickConversionsResponse,
-    UploadConversionAdjustmentsRequest,
-    UploadConversionAdjustmentsResponse,
-    UploadUserDataRequest,
-    UploadUserDataResponse,
-    UserDataOperation,
-  },
-  errors: {
-    GoogleAdsFailure,
-  },
-  enums: {
-    OfflineUserDataJobFailureReasonEnum: { OfflineUserDataJobFailureReason },
-    OfflineUserDataJobTypeEnum: { OfflineUserDataJobType },
-    OfflineUserDataJobStatusEnum: { OfflineUserDataJobStatus },
-    UserListMembershipStatusEnum: { UserListMembershipStatus },
-    UserListTypeEnum: { UserListType },
-    CustomerMatchUploadKeyTypeEnum: { CustomerMatchUploadKeyType },
-  },
-} = googleAdsLib;
-const {GoogleAdsApi} = require('google-ads-api');
-const lodash = require('lodash');
-
-const AuthClient = require('./auth_client.js');
-const {getLogger, BatchResult,} = require('../components/utils.js');
-
-/** @type {!ReadonlyArray<string>} */
-const API_SCOPES = Object.freeze(['https://www.googleapis.com/auth/adwords',]);
-
-/**
- * List of properties that will be taken from the data file as elements of a
- * conversion or a conversion adjustment.
- * @see https://developers.google.com/google-ads/api/reference/rpc/latest/ClickConversion
- * @see https://developers.google.com/google-ads/api/reference/rpc/latest/CallConversion
- * @see https://developers.google.com/google-ads/api/reference/rpc/latest/ConversionAdjustment
- * @type {Array<string>}
- */
-const PICKED_PROPERTIES = [
-  'external_attribution_data',
-  'cart_data',
-  'user_identifiers',
-  'gbraid',
-  'wbraid',
-  'gclid',
-  'caller_id',
-  'call_start_date_time',
-  'conversion_action',
-  'conversion_date_time',
-  'conversion_value',
-  'currency_code',
-  'order_id',
-  'adjustment_type',
-  'restatement_value',
-  'adjustment_date_time',
-  'user_agent',
-  'gclid_date_time_pair',
-  'consent',
-];
-
-/**
- * Kinds of UserIdentifier.
- * @see https://developers.google.com/google-ads/api/reference/rpc/latest/UserIdentifier
- * @type {Array<string>}
- */
-const IDENTIFIERS = [
-  'hashed_email',
-  'hashed_phone_number',
-  'mobile_id',
-  'third_party_user_id',
-  'address_info',
-];
-
-/**
- * Additional attributes in user data for store sales data or customer match.
- * @see https://developers.google.com/google-ads/api/reference/rpc/latest/UserData
- * @type {Array<string>}
- */
-const USERDATA_ADDITIONAL_ATTRIBUTES = [
-  'transaction_attribute',
-  'user_attribute',
-];
-
-/**
- * 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, call converions or conversion
- * adjustments for Google Ads, includes:
- * gclid, conversion_action, conversion_date_time, conversion_value,
- * currency_code, order_id, external_attribution_data,
- * caller_id, call_start_date_time,
- * adjustment_type, adjustment_date_time, user_agent, gclid_date_time_pair, etc.
- * @see PICKED_PROPERTIES
- *
- * Other properties that will be used to build the conversions but not picked by
- * the value directly including:
- * 1. 'user_identifier_source', source of the user identifier. If there is user
- * identifiers information in the conversion, this property should be set as
- * 'FIRST_PARTY'.
- * @see IDENTIFIERS
- * @see https://developers.google.com/google-ads/api/reference/rpc/latest/UserIdentifier?hl=en
- * 2. 'custom_variable_tags', the tags of conversion custom variables. To upload
- * custom variables, 'conversion_custom_variable_id' is required rather than the
- * 'tag'. So the invoker is expected to use the function
- * 'getConversionCustomVariableId' to get the ids and pass in as a
- * map(customVariables) of <tag, id> pairs before uploading conversions.
- *
- * @see https://developers.google.com/google-ads/api/reference/rpc/latest/ClickConversion
- * @typedef {{
- *   external_attribution_data: (GoogleAdsApi.ExternalAttributionData|undefined),
- *   cart_data: (object|undefined),
- *   gclid: (string|undefined),
- *   caller_id: (string|undefined),
- *   call_start_date_time: (string|undefined),
- *   conversion_action: string,
- *   conversion_date_time: string,
- *   conversion_value: number,
- *   currency_code:(string|undefined),
- *   order_id: (string|undefined),
- *   adjustment_type: (string|undefined),
- *   adjustment_date_time: (!ConversionAdjustmentType|undefined),
- *   user_agent: (string|undefined),
- *   user_identifier_source:(!UserIdentifierSource|undefined),
- *   custom_variable_tags:(!Array<string>|undefined),
- *   customVariables:(!Object<string,string>|undefined),
- * }}
- */
-let ConversionConfig;
-
-/**
- * Configuration for uploading customer match to Google Ads, includes:
- * customer_id, login_customer_id, list_id and operation.
- * If audience list_id is not present, 'list_name' and 'upload_key_type' need to
- * be there so they can be used to create a customer match user list.
- * operation must be one of the two: 'create' or 'remove'.
- * @see https://developers.google.com/google-ads/api/reference/rpc/latest/UserDataOperation
- * @see https://developers.google.com/google-ads/api/reference/rpc/latest/CustomerMatchUploadKeyTypeEnum.CustomerMatchUploadKeyType
- * @typedef {{
- *   customer_id: (string|number),
- *   login_customer_id: (string|number),
- *   list_id: (string|undefined),
- *   list_name: (string|undefined),
- *   upload_key_type: ('CONTACT_INFO'|'CRM_ID'|'MOBILE_ADVERTISING_ID'|undefined),
- *   operation: ('create'|'remove'),
- * }}
- */
-let CustomerMatchConfig;
-
-/**
- * Configuration for offline user data job, includes:
- * customer_id, login_customer_id, list_id, operation and type.
- * 'operation' should be one of the two: 'create' or 'remove',
- * 'type' is OfflineUserDataJobType, it can be 'CUSTOMER_MATCH_USER_LIST',
- * 'CUSTOMER_MATCH_WITH_ATTRIBUTES' or 'STORE_SALES_UPLOAD_FIRST_PARTY'.
- * For job type 'CUSTOMER_MATCH_USER_LIST', if `list_id` is not present,
- * 'list_name' and 'upload_key_type' need to be there so they can be used to
- *  create a customer match user list.
- * For job type 'CUSTOMER_MATCH_WITH_ATTRIBUTES', 'user_attribute' can be used
- * to store shared additional user attributes.
- * For job type 'STORE_SALES_UPLOAD_FIRST_PARTY', `store_sales_metadata` is
- * required to offer StoreSalesMetadata. Besides that, for the store sales data,
- * common data (e.g. `currency_code`, `conversion_action`) in
- * `transaction_attribute` can be put here as well.
- * @see https://developers.google.com/google-ads/api/reference/rpc/latest/OfflineUserDataJob
- * @typedef {{
- *   customer_id: (string|number),
- *   login_customer_id: (string|number),
- *   list_id: (string|undefined),
- *   list_name: (string|undefined),
- *   upload_key_type: ('CONTACT_INFO'|'CRM_ID'|'MOBILE_ADVERTISING_ID'|undefined),
- *   operation: ('create'|'remove'),
- *   type: !OfflineUserDataJobType,
- *   store_sales_metadata: (undefined|StoreSalesMetadata),
- *   transaction_attribute: (undefined|TransactionAttribute),
- *   user_attribute: (undefined|UserAttribute),
- * }}
- */
-let OfflineUserDataJobConfig;
-
-/**
- * Configuration for uploading customer match data for Google Ads.
- * @see https://developers.google.com/google-ads/api/reference/rpc/latest/UserIdentifier
- * @typedef {{
- *   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;
-
-/**
- * Configuration for querying report from Google Ads, includes:
- * entity, attributes, metrics, and constraints etc.
- * For other properties, see
- * https://opteo.com/dev/google-ads-api/#report
- * https://developers.google.com/google-ads/api/docs/query/grammar
- * @typedef {{
- *   entity:string,
- *   attributes:(!Array<string>|undefined),
- *   metrics:(!Array<string>|undefined),
- *   segments:(!Array<string>|undefined),
- *   constraints:(!Array<{
- *     key:string,
- *     op:string,
- *     val:string,
- *   }|{string,string}>|undefined),
- *   date_constant:(string|undefined),
- *   from_date:(string|undefined),
- *   to_date:(string|undefined),
- *   limit:(number|undefined),
- *   order_by:(string|undefined),
- *   sort_order:('DESC'|'ASC'|undefined),
- *   page_size:(number|undefined),
- * }}
- */
-let ReportQueryConfig;
-
-/**
- * Google Ads API class based on Opteo's Nodejs library.
- * see https://opteo.com/dev/google-ads-api/#features
- */
-class GoogleAds {
-  /**
-   * Note: Rate limits is set by the access level of Developer token.
-   * @param {string} developerToken Developer token to access the API.
-   * @param {boolean=} debugMode This is used to set ONLY validate conversions
-   *     but not real uploading.
-   * @param {!Object<string,string>=} env The environment object to hold env
-   *     variables.
-   */
-  constructor(developerToken, debugMode = false, env = process.env) {
-    this.developerToken = developerToken;
-    this.debugMode = debugMode;
-    this.authClient = new AuthClient(API_SCOPES, env);
-    this.logger = getLogger('API.ADS');
-    this.logger.debug(`Init ${this.constructor.name} with Debug Mode.`);
-  }
-
-  /**
-   * Gets a report synchronously from a given Customer account.
-   * The enum fields are present as index number.
-   * @param {string} customerId
-   * @param {string} loginCustomerId Login customer account ID (Mcc Account id).
-   * @param {!ReportQueryConfig} reportQueryConfig
-   * @return {!ReadableStream}
-   */
-  async getReport(customerId, loginCustomerId, reportQueryConfig) {
-    const customer = await this.getGoogleAdsApiCustomer_(
-      loginCustomerId, customerId);
-    return customer.report(reportQueryConfig);
-  }
-
-  /**
-   * Gets report as generator of a given Customer account.
-   * @param {string} customerId
-   * @param {string} loginCustomerId Login customer account ID (Mcc Account id).
-   * @param {!ReportQueryConfig} reportQueryConfig
-   * @return {!ReadableStream}
-   */
-  async generatorReport(customerId, loginCustomerId, reportQueryConfig) {
-    const customer = await this.getGoogleAdsApiCustomer_(
-      loginCustomerId, customerId);
-    return customer.reportStream(reportQueryConfig);
-  }
-
-  /**
-   * Gets stream report of a given Customer account.
-   * @param {string} customerId
-   * @param {string} loginCustomerId Login customer account ID (Mcc Account id).
-   * @param {!ReportQueryConfig} reportQueryConfig
-   * @return {!ReadableStream}
-   */
-  async streamReport(customerId, loginCustomerId, reportQueryConfig) {
-    const customer = await this.getGoogleAdsApiCustomer_(
-      loginCustomerId, customerId);
-    return customer.reportStreamRaw(reportQueryConfig);
-  }
-
-  /**
-   * Returns resources information from Google Ads API. see:
-   * https://developers.google.com/google-ads/api/docs/concepts/field-service
-   * Note, it looks like this function doesn't check the CID, just using
-   * developer token and OAuth.
-   * @param {string|number} loginCustomerId Login customer account ID.
-   * @param {Array<string>} adFields Array of Ad fields.
-   * @param {Array<string>} metadata Select fields, default values are:
-   *     name, data_type, is_repeated, type_url.
-   * @return {!Promise<!Array<GoogleAdsField>>}
-   */
-  async searchMetaData(loginCustomerId, adFields, metadata = [
-    'name', 'data_type', 'is_repeated', 'type_url',]) {
-    const customer = await this.getGoogleAdsApiCustomer_(loginCustomerId);
-    const selectClause = metadata.join(',');
-    const fields = adFields.join('","');
-    const query = `SELECT ${selectClause} WHERE name IN ("${fields}")`;
-    const request = new SearchGoogleAdsFieldsRequest({query});
-    const [results] = await customer.googleAdsFields
-        .searchGoogleAdsFields(request);
-    return results;
-  }
-  /**
-   * Returns the function to send out a request to Google Ads API with a batch
-   * of call conversions.
-   * @param {string} customerId
-   * @param {string} loginCustomerId Login customer account ID (Mcc Account id).
-   * @param {!ConversionConfig} adsConfig Default call conversion params
-   * @return {!SendSingleBatch} Function which can send a batch of hits to
-   *     Google Ads API.
-   */
-  getUploadCallConversionFn(customerId, loginCustomerId, adsConfig) {
-    return this.getUploadConversionFnBase_(customerId, loginCustomerId,
-      adsConfig, 'uploadCallConversions', 'caller_id');
-  }
-
-  /**
-   * Returns the function to send out a request to Google Ads API with a batch
-   * of click conversions.
-   * @param {string} customerId
-   * @param {string} loginCustomerId Login customer account ID (Mcc Account id).
-   * @param {!ConversionConfig} adsConfig Default click conversion params
-   * @return {!SendSingleBatch} Function which can send a batch of hits to
-   *     Google Ads API.
-   */
-  getUploadClickConversionFn(customerId, loginCustomerId, adsConfig) {
-    return this.getUploadConversionFnBase_(customerId, loginCustomerId,
-      adsConfig, 'uploadClickConversions', 'gclid');
-  }
-
-  /**
-   * Returns the function to send out a request to Google Ads API with a batch
-   * of conversion adjustments.
-   * @param {string} customerId
-   * @param {string} loginCustomerId Login customer account ID (Mcc Account id).
-   * @param {!ConversionConfig} adsConfig Default conversion adjustments
-   *     params.
-   * @return {!SendSingleBatch} Function which can send a batch of hits to
-   *     Google Ads API.
-   */
-  getUploadConversionAdjustmentFn(customerId, loginCustomerId, adsConfig) {
-    return this.getUploadConversionFnBase_(customerId, loginCustomerId,
-      adsConfig, 'uploadConversionAdjustments', 'order_id');
-  }
-
-  /**
-   * Returns the function to send call conversions, click conversions or
-   * conversion adjustment (enhanced conversions).
-   * @param {string} customerId
-   * @param {string} loginCustomerId Login customer account ID (Mcc Account id).
-   * @param {!ConversionConfig} adsConfig Default click conversion params
-   * @param {string} functionName The name of sending converions function, could
-   *   be `uploadClickConversions`, `uploadCallConversions` or
-   *   `uploadConversionAdjustments`.
-   * @param {string} propertyForDebug The name of property for debug info.
-   * @return {!SendSingleBatch} Function which can send a batch of hits to
-   *     Google Ads API.
-   * @private
-   */
-  getUploadConversionFnBase_(customerId, loginCustomerId, adsConfig,
-    functionName, propertyForDebug) {
-    /**
-     * Sends a batch of hits to Google Ads API.
-     * @param {!Array<string>} lines Data for single request. It should be
-     *     guaranteed that it doesn't exceed quota limitation.
-     * @param {string} batchId The tag for log.
-     * @return {!BatchResult}
-     */
-    return async (lines, batchId) => {
-      /** @type {!Array<ConversionConfig>} */
-      const conversions = lines.map(
-        (line) => buildClickConversionFromLine(line, adsConfig, customerId));
-      /** @const {BatchResult} */
-      const batchResult = {
-        result: true,
-        numberOfLines: lines.length,
-      };
-      try {
-        const response = await this[functionName](conversions, customerId,
-          loginCustomerId);
-        const { results, partial_failure_error: failed } = response;
-        if (this.logger.isDebugEnabled()) {
-          const id = results.map((conversion) => conversion[propertyForDebug]);
-          this.logger.debug(`Uploaded ${propertyForDebug}:`, id);
-        }
-        if (failed) {
-          this.logger.info('partial_failure_error:', failed.message);
-          const failures = failed.details.map(
-            ({ value }) => GoogleAdsFailure.decode(value));
-          this.extraFailedLines_(batchResult, failures, lines, 0);
-        }
-        return batchResult;
-      } catch (error) {
-        this.logger.error(
-          `Error in ${functionName} batch: ${batchId}`, error);
-        this.updateBatchResultWithError(batchResult, error, lines, 0);
-        return batchResult;
-      }
-    }
-  }
-
-  /**
-   * Updates the BatchResult based on errors.
-   *
-   * There are 2 types of errors here:
-   * 1. Normal JavaScript Error object. It happens when the whole process fails
-   * (not partial failure), so there is no detailed failed lines.
-   * 2. GoogleAdsFailure. It is a Google Ads' own error object which has an
-   * array of GoogleAdsError (property name 'errors'). GoogleAdsError contains
-   * the detailed failed data if it is a line-error. For example, a wrong
-   * encoded user identifier is a line-error, while a wrong user list id is not.
-   * GoogleAdsFailure: https://developers.google.com/google-ads/api/reference/rpc/latest/GoogleAdsFailure
-   * GoogleAdsError: https://developers.google.com/google-ads/api/reference/rpc/latest/GoogleAdsError
-   *
-   * For Customer Match data uploading, there is not partial failure, so the
-   * result can be either succeeded or a thrown error. The thrown error will be
-   * used to build the returned result here.
-   * For Conversions uploading (partial failure enabled), if there is an error
-   * fails the whole process, the error will also be thrown and handled here.
-   * Otherwise, the errors will be wrapped in the response as the property named
-   * 'partial_failure_error' which contains an array of GoogleAdsFailure. This
-   * kind of failure doesn't fail the process, while line-errors can be
-   * extracted from it.
-   * For more information, see the function `extraFailedLines_`.
-   *
-   * An example of 'GoogleAdsFailure' is:
-   * GoogleAdsFailure {
-   *   errors: [
-   *     GoogleAdsError {
-   *       error_code: ErrorCode { offline_user_data_job_error: 25 },
-   *       message: 'The SHA256 encoded value is malformed.',
-   *       location: ErrorLocation {
-   *         field_path_elements: [
-   *           FieldPathElement { field_name: 'operations', index: 0 },
-   *           FieldPathElement { field_name: 'create' },
-   *           FieldPathElement { field_name: 'user_identifiers', index: 0 },
-   *           FieldPathElement { field_name: 'hashed_email' }
-   *         ]
-   *       }
-   *     }
-   *   ],
-   *   request_id: 'xxxxxxxxxxxxxxx'
-   * }
-   *
-   * @param {!BatchResult} batchResult
-   * @param {(!GoogleAdsFailure|!Error)} error
-   * @param {!Array<string>} lines The original input data.
-   * @param {number} fieldPathIndex The index of 'FieldPathElement' in the array
-   *     'field_path_elements'. This is used to get the original line related to
-   *     this GoogleAdsError.
-   */
-  updateBatchResultWithError(batchResult, error, lines, fieldPathIndex) {
-    batchResult.result = false;
-    if (error.errors) { //GoogleAdsFailure
-      this.extraFailedLines_(batchResult, [error], lines, fieldPathIndex);
-    } else {
-      batchResult.errors = [error.message || error.toString()];
-    }
-  }
-
-  /**
-   * Extras failed lines based on the GoogleAdsFailures.
-   *
-   * Different errors have different 'fieldPathIndex' which is the index of
-   * failed lines in original input data (an array of a string).
-   *
-   * For conversions, the ErrorLocation is like:
-   * ErrorLocation {
-   *   field_path_elements: [
-   *     FieldPathElement { field_name: 'operations', index: 0 },
-   *     FieldPathElement { field_name: 'create' }
-   *   ]
-   * }
-   * So the index is 0, index of 'operations'.
-   *
-   * For customer match upload, the ErrorLocation is like:
-   * ErrorLocation {
-   *   field_path_elements: [
-   *     FieldPathElement { field_name: 'operations', index: 0 },
-   *     FieldPathElement { field_name: 'create' },
-   *     FieldPathElement { field_name: 'user_identifiers', index: 0 },
-   *     FieldPathElement { field_name: 'hashed_email' }
-   *   ]
-   * }
-   * The index should be 2, index of 'user_identifiers'.
-   *
-   * With this we can get errors and failed lines. The function will set
-   * following for the given BatchResult object:
-   *   result - false
-   *   errors - de-duplicated error reasons
-   *   failedLines - failed lines, an array of string. Without the reason of
-   *     failure.
-   *   groupedFailed - a hashmap of failed the lines. The key is the reason, the
-   *     value is the array of failed lines due to this reason.
-   * @param {!BatchResult} batchResult
-   * @param {!Array<!GoogleAdsFailure>} failures
-   * @param {!Array<string>} lines The original input data.
-   * @param {number} fieldPathIndex The index of 'FieldPathElement' in the array
-   *     'field_path_elements'. This is used to get the original line related to
-   *     this GoogleAdsError.
-   * @private
-   */
-  extraFailedLines_(batchResult, failures, lines, fieldPathIndex) {
-    batchResult.result = false;
-    batchResult.failedLines = [];
-    batchResult.groupedFailed = {};
-    const errors = new Set();
-    failures.forEach((failure) => {
-      failure.errors.forEach(({message, location}) => {
-        errors.add(message);
-        if (location && location.field_path_elements[fieldPathIndex]) {
-          const {index} = location.field_path_elements[fieldPathIndex];
-          if (typeof index === 'undefined') {
-            this.logger.warn(`Unknown field path index: ${fieldPathIndex}`,
-                location.field_path_elements);
-          } else {
-            const groupedFailed = batchResult.groupedFailed[message] || [];
-            const failedLine = lines[index];
-            batchResult.failedLines.push(failedLine);
-            groupedFailed.push(failedLine);
-            if (groupedFailed.length === 1) {
-              batchResult.groupedFailed[message] = groupedFailed;
-            }
-          }
-        }
-      });
-    });
-    batchResult.errors = Array.from(errors);
-  }
-
-  /**
-   * Uploads call conversions to google ads account.
-   * It requires an array of call conversions and customer id.
-   * In DEBUG mode, this function will only validate the conversions.
-   * @param {Array<ConversionConfig>} callConversions Call Conversions
-   * @param {string} customerId
-   * @param {string} loginCustomerId Login customer account ID (Mcc Account id).
-   * @return {!Promise<!UploadCallConversionsResponse>}
-   */
-  async uploadCallConversions(callConversions, customerId, loginCustomerId) {
-    this.logger.debug('Upload call conversions for customerId:', customerId);
-    const customer = await this.getGoogleAdsApiCustomer_(
-      loginCustomerId, customerId);
-    const request = new UploadCallConversionsRequest({
-      conversions: callConversions,
-      customer_id: customerId,
-      validate_only: this.debugMode, // when true makes no changes
-      partial_failure: true, // Will still create the non-failed entities
-    });
-    return customer.conversionUploads.uploadCallConversions(request);
-  }
-
-  /**
-   * Uploads click conversions to google ads account.
-   * It requires an array of click conversions and customer id.
-   * In DEBUG mode, this function will only validate the conversions.
-   * @param {Array<ConversionConfig>} clickConversions ClickConversions
-   * @param {string} customerId
-   * @param {string} loginCustomerId Login customer account ID (Mcc Account id).
-   * @return {!Promise<!UploadClickConversionsResponse>}
-   */
-  async uploadClickConversions(clickConversions, customerId, loginCustomerId) {
-    this.logger.debug('Upload click conversions for customerId:', customerId);
-    const customer = await this.getGoogleAdsApiCustomer_(
-      loginCustomerId, customerId);
-    const request = new UploadClickConversionsRequest({
-      conversions: clickConversions,
-      customer_id: customerId,
-      validate_only: this.debugMode, // when true makes no changes
-      partial_failure: true, // Will still create the non-failed entities
-    });
-    return customer.conversionUploads.uploadClickConversions(request);
-  }
-
-  /**
-   * Uploads conversion adjustments to google ads account.
-   * It requires an array of conversion adjustments and customer id.
-   * In DEBUG mode, this function will only validate the conversion adjustments.
-   * @param {Array<ConversionAdjustment>} conversionAdjustments Conversion
-   *     adjustments.
-   * @param {string} customerId
-   * @param {string} loginCustomerId Login customer account ID (Mcc Account id).
-   * @return {!Promise<!UploadConversionAdjustmentsResponse>}
-   */
-  async uploadConversionAdjustments(conversionAdjustments, customerId,
-      loginCustomerId) {
-    this.logger.debug('Upload conversion adjustments for customerId:',
-        customerId);
-    const customer = await this.getGoogleAdsApiCustomer_(
-      loginCustomerId, customerId);
-    const request = new UploadConversionAdjustmentsRequest({
-      conversion_adjustments: conversionAdjustments,
-      customer_id: customerId,
-      validate_only: this.debugMode, // when true makes no changes
-      partial_failure: true, // Will still create the non-failed entities
-    });
-    return customer.conversionAdjustmentUploads.uploadConversionAdjustments(
-        request);
-  }
-
-  /**
-   * Returns the id of Conversion Custom Variable with the given tag.
-   * @param {string} tag Custom Variable tag.
-   * @param {string} customerId
-   * @param {string} loginCustomerId Login customer account ID (Mcc Account id).
-   * @return {Promise<number|undefined>} Returns undefined if can't find tag.
-   */
-  async getConversionCustomVariableId(tag, customerId, loginCustomerId) {
-    const customer = await this.getGoogleAdsApiCustomer_(
-      loginCustomerId, customerId);
-    const customVariables = await customer.query(`
-        SELECT conversion_custom_variable.id,
-               conversion_custom_variable.tag
-        FROM conversion_custom_variable
-        WHERE conversion_custom_variable.tag = "${tag}" LIMIT 1
-    `);
-    if (customVariables.length > 0) {
-      return customVariables[0].conversion_custom_variable.id;
-    }
-  }
-
-  /**
-   * Gets the user list_id of a given list name and upload key type. It
-   * only looks for a CRM_BASED and OPEN list.
-   * @param {!CustomerMatchConfig} customerMatchConfig
-   * @return {number|undefined} User list_id if it exists.
-   */
-  async getCustomerMatchUserListId(customerMatchConfig) {
-    const customerId = this.getCleanCid_(customerMatchConfig.customer_id);
-    const loginCustomerId = this.getCleanCid_(
-      customerMatchConfig.login_customer_id);
-    const listName = customerMatchConfig.list_name;
-    const uploadKeyType = customerMatchConfig.upload_key_type;
-    const reportConfig = {
-      entity: 'user_list',
-      attributes: [
-        'user_list.id',
-        'user_list.resource_name',
-      ],
-      constraints: {
-        'user_list.name': listName,
-        'customer.id': customerId,
-        'user_list.type': UserListType.CRM_BASED,
-        'user_list.membership_status': UserListMembershipStatus.OPEN,
-        'user_list.crm_based_user_list.upload_key_type': uploadKeyType,
-      },
-    };
-    const userlists =
-      await this.getReport(customerId, loginCustomerId, reportConfig);
-    return userlists.length === 0 ? undefined : userlists[0].user_list.id;
-  }
-
-  /**
-   * Creates the user list based on a given customerMatchConfig and returns the
-   * Id. The user list would be a CRM_BASED type.
-   * Trying to create a list with an used name will fail.
-   * @param {!CustomerMatchConfig} customerMatchConfig
-   * @return {number} The created user list id. Note this is not the resource
-   *   name.
-   */
-  async createCustomerMatchUserList(customerMatchConfig) {
-    const customerId = this.getCleanCid_(customerMatchConfig.customer_id);
-    const loginCustomerId = this.getCleanCid_(
-      customerMatchConfig.login_customer_id);
-    const listName = customerMatchConfig.list_name;
-    const uploadKeyType = customerMatchConfig.upload_key_type;
-    const userList = UserList.create({
-      name: listName,
-      type: UserListType.CRM_BASED,
-      crm_based_user_list: { upload_key_type: uploadKeyType },
-    });
-    const options = {
-      validate_only: this.debugMode, // when true makes no changes
-      partial_failure: true, // Will still create the non-failed entities
-    };
-    const customer = await this.getGoogleAdsApiCustomer_(
-      loginCustomerId, customerId);
-    const response = await customer.userLists.create([userList], options);
-    const { results, partial_failure_error: failed } = response;
-    if (this.logger.isDebugEnabled()) {
-      this.logger.debug(`Created crm userlist from`, customerMatchConfig);
-    }
-    if (failed) {
-      const failures = failed.errors.map(({ message }) => message).join(' ');
-      this.logger.info('partial_failure_error:', failures);
-      throw new Error(failures);
-    }
-    if (!results[0]) {
-      if (this.debugMode) {
-        throw new Error('No UserList was created in DEBUG mode.');
-      } else {
-        throw new Error('No UserList was created.');
-      }
-    }
-    const resourceName = results[0].resource_name;
-    const splitted = resourceName.split('/');
-    return splitted[splitted.length - 1];
-  }
-
-  /**
-   * Returns the function to send out a request to Google Ads API with
-   * user ids for Customer Match upload
-   * @param {!CustomerMatchConfig} customerMatchConfig
-   * @return {!SendSingleBatch} Function which can send a batch of hits to
-   *     Google Ads API.
-   */
-  getUploadCustomerMatchFn(customerMatchConfig) {
-    /**
-     * Sends a batch of hits to Google Ads API.
-     * @param {!Array<string>} lines Data for single request. It should be
-     *     guaranteed that it doesn't exceed quota limitation.
-     * @param {string} batchId The tag for log.
-     * @return {!Promise<BatchResult>}
-     */
-    return async (lines, batchId) => {
-      /** @type {Array<CustomerMatchRecord>} */
-      const userIds = lines.map((line) => JSON.parse(line));
-      /** @const {BatchResult} */ const batchResult = {
-        result: true,
-        numberOfLines: lines.length,
-      };
-      try {
-        const response = await this.uploadUserDataToUserList(userIds,
-            customerMatchConfig);
-        this.logger.debug(`Customer Match upload batch[${batchId}]`, response);
-        return batchResult;
-      } catch (error) {
-        this.logger.error(
-            `Error in Customer Match upload batch[${batchId}]`, error);
-        this.updateBatchResultWithError(batchResult, error, lines, 2);
-        return batchResult;
-      }
-    }
-  }
-
-  /**
-   * Uploads a user data to a user list (aka customer match).
-   * @see https://developers.google.com/google-ads/api/reference/rpc/latest/UserDataService
-   * @see https://developers.google.com/google-ads/api/reference/rpc/latest/UserDataOperation
-   * @see https://developers.google.com/google-ads/api/reference/rpc/latest/UserData
-   * @see https://developers.google.com/google-ads/api/reference/rpc/latest/UserIdentifier
-   * @see https://developers.google.com/google-ads/api/reference/rpc/latest/CustomerMatchUserListMetadata
-   * Please note: The UserDataService has a limit of 10 UserDataOperations
-   * and 100 user IDs per request
-   * @see https://developers.google.com/google-ads/api/docs/migration/user-data-service#rate_limits
-   * @param {!Array<CustomerMatchRecord>} customerMatchRecords user Ids
-   * @param {CustomerMatchConfig} customerMatchConfig Customer Match config containing
-   * customer_id, login_customer_id, list_id, list_type which can be one of the following
-   * hashed_email, hashed_phone_number, mobile_id, third_party_user_id or address_info and
-   * operation which can be either 'create' or 'remove'
-   * @return {!Promise<UploadUserDataResponse>}
-   */
-  async uploadUserDataToUserList(customerMatchRecords, customerMatchConfig) {
-    const customerId = this.getCleanCid_(customerMatchConfig.customer_id);
-    const loginCustomerId = this.getCleanCid_(
-      customerMatchConfig.login_customer_id);
-    const userListId = customerMatchConfig.list_id;
-    const operation = customerMatchConfig.operation;
-
-    const customer = await this.getGoogleAdsApiCustomer_(
-      loginCustomerId, customerId);
-    const operationsList = this.buildOperationsList_(operation,
-        customerMatchRecords);
-    const metadata = this.buildCustomerMatchUserListMetadata_(customerId,
-        userListId);
-    const request = UploadUserDataRequest.create({
-      customer_id: customerId,
-      operations: operationsList,
-      customer_match_user_list_metadata: metadata,
-    });
-    const response = await customer.userData.uploadUserData(request);
-    return response;
-  }
-
-  /**
-   * Builds a list of UserDataOperations.
-   * Since v6 you can set a user_attribute
-   * @see https://developers.google.com/google-ads/api/reference/rpc/latest/UserData
-   * @see https://developers.google.com/google-ads/api/reference/rpc/latest/UserIdentifier
-   * @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 {{
-   *   transaction_attribute: TransactionAttribute|undefined,
-   *   user_attribute: UserAttribute,
-   * }} additionalAttributes Additional attributes for 'UserData', includes
-   * 'transaction_attribute' or 'user_attribute'.
-   * @return {Array<UserDataOperation>}
-   * @private
-   */
-  buildOperationsList_(operationType, customerMatchRecords,
-    additionalAttributes = {}) {
-    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}));
-          }
-        }
-      });
-      const userData = {};
-      if (userIdentifiers.length <= MAX_IDENTIFIERS_PER_USER) {
-        userData.user_identifiers = userIdentifiers;
-      } else {
-        this.logger.warn(
-            `Too many user identifiers, will only send ${MAX_IDENTIFIERS_PER_USER}:`,
-            JSON.stringify(customerMatchRecord));
-        userData.user_identifiers =
-          userIdentifiers.slice(0, MAX_IDENTIFIERS_PER_USER);
-      }
-      USERDATA_ADDITIONAL_ATTRIBUTES.forEach((attribute) => {
-        if (additionalAttributes[attribute] || customerMatchRecord[attribute]) {
-          userData[attribute] = lodash.merge(
-            {}, additionalAttributes[attribute], customerMatchRecord[attribute]);
-        }
-      })
-      return UserDataOperation.create(
-        { [operationType]: UserData.create(userData) });
-    });
-  }
-
-  /**
-   * Creates CustomerMatchUserListMetadata.
-   * @see https://developers.google.com/google-ads/api/reference/rpc/latest/CustomerMatchUserListMetadata
-   * @param {string} customerId part of the ResourceName to be mutated
-   * @param {string} userListId part of the ResourceName to be mutated
-   * @return {!CustomerMatchUserListMetadata}
-   * @private
-   */
-  buildCustomerMatchUserListMetadata_(customerId, userListId) {
-    const resourceName = `customers/${customerId}/userLists/${userListId}`;
-    return CustomerMatchUserListMetadata.create({
-      user_list: resourceName,
-    });
-  }
-
-  /**
-   * Returns a integer format CID by removing dashes.
-   * @param {string} cid
-   * @return {string}
-   * @private
-   */
-  getCleanCid_(cid) {
-    return cid.replace(/-/g, '');
-  }
-
-  /**
-   * Get OfflineUserDataJob status.
-   * @param {OfflineUserDataJobConfig} config Offline user data job config.
-   * @param {string} resourceName
-   * @return {!OfflineUserDataJobStatus} Job status
-   */
-  async getOfflineUserDataJob(config, resourceName) {
-    const loginCustomerId = this.getCleanCid_(config.login_customer_id);
-    const customerId = this.getCleanCid_(config.customer_id);
-    const reportConfig = {
-      entity: 'offline_user_data_job',
-      attributes: [
-        'offline_user_data_job.id',
-        'offline_user_data_job.status',
-        'offline_user_data_job.type',
-        'offline_user_data_job.customer_match_user_list_metadata.user_list',
-        'offline_user_data_job.failure_reason',
-      ],
-      constraints: {
-        'offline_user_data_job.resource_name': resourceName,
-      },
-    };
-    const jobs = await this.getReport(customerId, loginCustomerId, reportConfig);
-    if (jobs.length === 0) {
-      throw new Error(`Can't find the OfflineUserDataJob: ${resourceName}`);
-    }
-    const { failure_reason: failure, status } = jobs[0].offline_user_data_job;
-    if (failure > 0) {
-      this.logger.warn(`Offline UserData Job [${resourceName}] failed: `,
-        OfflineUserDataJobFailureReason[failure])
-    }
-    return OfflineUserDataJobStatus[status];
-  }
-
-  /**
-   * Creates a OfflineUserDataJob and returns resource name.
-   * @param {OfflineUserDataJobConfig} config Offline user data job config.
-   * @return {string} The resouce name of the creaed job.
-   */
-  async createOfflineUserDataJob(config) {
-    const loginCustomerId = this.getCleanCid_(config.login_customer_id);
-    const customerId = this.getCleanCid_(config.customer_id);
-    const { list_id: userListId, type } = config;
-    this.logger.debug('Creating OfflineUserDataJob for CID:', customerId);
-    const customer = await this.getGoogleAdsApiCustomer_(
-      loginCustomerId, customerId);
-    const job = OfflineUserDataJob.create({
-      type,
-    });
-    // https://developers.google.com/google-ads/api/rest/reference/rest/latest/customers.offlineUserDataJobs?hl=en#CustomerMatchUserListMetadata
-    if (type.startsWith('CUSTOMER_MATCH')) {
-      const metadata = this.buildCustomerMatchUserListMetadata_(customerId,
-        userListId);
-      job.customer_match_user_list_metadata = metadata;
-      // https://developers.google.com/google-ads/api/rest/reference/rest/latest/customers.offlineUserDataJobs?hl=en#StoreSalesMetadata
-    } else if (type.startsWith('STORE_SALES')) {
-      // Support previous property 'StoreSalesMetadata' for compatibility.
-      if (config.store_sales_metadata || config.StoreSalesMetadata) {
-        job.store_sales_metadata = config.store_sales_metadata
-          || config.StoreSalesMetadata;
-      }
-    } else {
-      throw new Error(`UNSUPPORTED OfflineUserDataJobType: ${type}.`);
-    }
-    const request = CreateOfflineUserDataJobRequest.create({
-      customer_id: customerId,
-      job,
-      validate_only: this.debugMode, // when true makes no changes
-      enable_match_rate_range_preview: true,
-    });
-    const { resource_name: resourceName } =
-      await customer.offlineUserDataJobs.createOfflineUserDataJob(request);
-    this.logger.info('Created OfflineUserDataJob:', resourceName);
-    return resourceName;
-  }
-
-  /**
-   * Adds user data in to the OfflineUserDataJob.
-   * @param {OfflineUserDataJobConfig} config Offline user data job config.
-   * @param {string} jobResourceName
-   * @param {!Array<CustomerMatchRecord>} customerMatchRecords user Ids
-   * @return {!Promise<AddOfflineUserDataJobOperationsResponse>}
-   */
-  async addOperationsToOfflineUserDataJob(config, jobResourceName, records) {
-    const start = new Date().getTime();
-    const loginCustomerId = this.getCleanCid_(config.login_customer_id);
-    const customerId = this.getCleanCid_(config.customer_id);
-    const operation = config.operation;
-    const customer = await this.getGoogleAdsApiCustomer_(
-      loginCustomerId, customerId);
-    const operationsList = this.buildOperationsList_(operation, records, config);
-    const request = AddOfflineUserDataJobOperationsRequest.create({
-      resource_name: jobResourceName,
-      operations: operationsList,
-      validate_only: false,//this.debugMode,
-      enable_partial_failure: true,
-      enable_warnings: true,
-    });
-    const response = await customer.
-      offlineUserDataJobs.addOfflineUserDataJobOperations(request);
-    this.logger.debug(`Added ${records.length} records in (ms):`,
-      new Date().getTime() - start);
-    return response;
-  }
-
-  /**
-   * Starts the OfflineUserDataJob.
-   * @param {OfflineUserDataJobConfig} config Offline user data job config.
-   * @param {string} jobResourceName
-   * @returns
-   */
-  async runOfflineUserDataJob(config, jobResourceName) {
-    const loginCustomerId = this.getCleanCid_(config.login_customer_id);
-    const customerId = this.getCleanCid_(config.customer_id);
-    const customer = await this.getGoogleAdsApiCustomer_(
-      loginCustomerId, customerId);
-    const request = RunOfflineUserDataJobRequest.create({
-      resource_name: jobResourceName,
-      validate_only: false,//this.debugMode,
-    });
-    const rawResponse = await customer.
-        offlineUserDataJobs.runOfflineUserDataJob(request);
-    const response = lodash.pick(rawResponse, ['name', 'done', 'error']);
-    this.logger.debug('runOfflineUserDataJob response: ', response);
-    return response;
-  }
-
-  /**
-   * Returns the function to send out a request to Google Ads API with
-   * user data as operations in OfflineUserDataJob.
-   * @param {!OfflineUserDataJobConfig} config
-   * @param {string} jobResourceName
-   * @return {!SendSingleBatch} Function which can send a batch of hits to
-   *     Google Ads API.
-   */
-  getAddOperationsToOfflineUserDataJobFn(config, jobResourceName) {
-    /**
-     * Sends a batch of hits to Google Ads API.
-     * @param {!Array<string>} lines Data for single request. It should be
-     *     guaranteed that it doesn't exceed quota limitation.
-     * @param {string} batchId The tag for log.
-     * @return {!Promise<BatchResult>}
-     */
-    return async (lines, batchId) => {
-      /** @type {Array<CustomerMatchRecord>} */
-      const records = lines.map((line) => JSON.parse(line));
-      /** @const {BatchResult} */ const batchResult = {
-        result: true,
-        numberOfLines: lines.length,
-      };
-      try {
-        const response = await this.addOperationsToOfflineUserDataJob(config,
-          jobResourceName, records);
-        this.logger.debug(`Add operation to job batch[${batchId}]`, response);
-        const { results, partial_failure_error: failed } = response;
-        if (failed) {
-          this.logger.info('partial_failure_error:', failed.message);
-          const failures = failed.details.map(
-            ({ value }) => GoogleAdsFailure.decode(value));
-          this.extraFailedLines_(batchResult, failures, lines, 0);
-        }
-        return batchResult;
-      } catch (error) {
-        this.logger.error(
-          `Error in OfflineUserDataJob add operations batch[${batchId}]`, error);
-        this.updateBatchResultWithError(batchResult, error, lines, 2);
-        return batchResult;
-      }
-    }
-  }
-
-  /**
-   * Returns an instance of GoogleAdsApi.Customer on google-ads-api.
-   * @param {string} loginCustomerId Login customer account ID (Mcc Account id).
-   * @param {string=} customerId Customer account ID, default is the same as
-   *     the login customer account ID.
-   * @return {GoogleAdsApi.Customer}
-   * @private
-   */
-  async getGoogleAdsApiCustomer_(loginCustomerId, customerId = loginCustomerId) {
-    if (this.googleAds) return this.googleAds;
-    await this.authClient.prepareCredentials();
-    const oauthClient = await this.authClient.getOAuth2Token();
-    /** @const {GoogleAdsApi} */
-    const googleAdsApiClient = new GoogleAdsApi({
-      client_id: oauthClient.clientId,
-      client_secret: oauthClient.clientSecret,
-      developer_token: this.developerToken,
-    });
-    this.googleAds = googleAdsApiClient.Customer({
-      customer_id: customerId,
-      login_customer_id: loginCustomerId,
-      refresh_token: oauthClient.refreshToken,
-    });
-    return this.googleAds;
-  }
-
-}
-
-/**
- * Returns a conversion object based the given config and line data.
- * @param {string} line A JSON string of a conversion data.
- * @param {ConversionConfig} config Default click conversion params
- * @param {string} customerId
- * @return {object} A conversion
- */
-const buildClickConversionFromLine = (line, config, customerId) => {
-  const {customVariables, user_identifier_source} = config;
-  const record = JSON.parse(line);
-  const conversion = lodash.merge(lodash.pick(config, PICKED_PROPERTIES),
-      lodash.pick(record, PICKED_PROPERTIES));
-  if (customVariables) {
-    const tags = Object.keys(customVariables);
-    conversion.custom_variables = tags.map((tag) => {
-      return {
-        conversion_custom_variable:
-            `customers/${customerId}/conversionCustomVariables/${customVariables[tag]}`,
-        value: record[tag],
-      };
-    });
-  }
-  const user_identifiers = [];
-  IDENTIFIERS.forEach((identifier) => {
-    if (record[identifier]) {
-      user_identifiers.push({
-        user_identifier_source,
-        [identifier]: record[identifier],
-      });
-    }
-  });
-  if (user_identifiers.length > 0) {
-    conversion.user_identifiers = user_identifiers;
-  }
-  return conversion;
-}
-
-module.exports = {
-  ConversionConfig,
-  CustomerMatchRecord,
-  CustomerMatchConfig,
-  OfflineUserDataJobType,
-  OfflineUserDataJobConfig,
-  GoogleAds,
-  ReportQueryConfig,
-  GoogleAdsField,
-  buildClickConversionFromLine,
-};