@google-cloud/nodejs-common 2.0.16-beta → 2.1.1

package/src/apis/doubleclick_search.js

@@ -19,9 +19,8 @@
 
 'use strict';
 
-const {google} = require('googleapis');
 const {request} = require('gaxios');
-const AuthClient = require('./auth_client.js');
+const { GoogleApiClient } = require('./base/google_api_client.js');
 const {
   getLogger,
   SendSingleBatch,
@@ -118,7 +117,7 @@ let ReportRequest;
  * Quota limits, see:
  * https://support.google.com/adsihc/answer/6346075?hl=en
  */
-class DoubleClickSearch {
+class DoubleClickSearch extends GoogleApiClient {
 
   /**
    * @constructor
@@ -126,34 +125,19 @@ class DoubleClickSearch {
    *     variables.
    */
   constructor(env = process.env) {
-    this.authClient = new AuthClient(API_SCOPES, env);
+    super(env);
+    this.googleApi = 'doubleclicksearch';
     this.logger = getLogger('API.DS');
   }
 
-  /**
-   * Prepares the Google SA360 instance.
-   * @return {!google.doubleclicksearch}
-   * @private
-   */
-  async getApiClient_() {
-    if (this.doubleclicksearch) return this.doubleclicksearch;
-    this.logger.debug(`Initialized ${this.constructor.name} instance.`);
-    this.doubleclicksearch = google.doubleclicksearch({
-      version: API_VERSION,
-      auth: await this.getAuth_(),
-    });
-    return this.doubleclicksearch;
+  /** @override */
+  getScope() {
+    return API_SCOPES;
   }
 
-  /**
-   * Gets the auth object.
-   * @return {!Promise<{!OAuth2Client|!JWT|!Compute}>}
-   */
-  async getAuth_() {
-    if (this.auth) return this.auth;
-    await this.authClient.prepareCredentials();
-    this.auth = this.authClient.getDefaultAuth();
-    return this.auth;
+  /** @override */
+  getVersion() {
+    return API_VERSION;
   }
 
   /**
@@ -172,7 +156,7 @@ class DoubleClickSearch {
     });
     this.logger.debug('Sending out availabilities', availabilities);
     try {
-      const doubleclicksearch = await this.getApiClient_();
+      const doubleclicksearch = await this.getApiClient();
       const response = await doubleclicksearch.conversion.updateAvailability(
           {requestBody: {availabilities}});
       this.logger.debug('Get response: ', response);
@@ -221,7 +205,7 @@ class DoubleClickSearch {
         numberOfLines: lines.length,
       };
       try {
-        const doubleclicksearch = await this.getApiClient_();
+        const doubleclicksearch = await this.getApiClient();
         const response = await doubleclicksearch.conversion.insert(
             {requestBody: {conversion: conversions}}
         );
@@ -322,7 +306,7 @@ class DoubleClickSearch {
    * @return {!Promise<string>}
    */
   async requestReports(requestBody) {
-    const doubleclicksearch = await this.getApiClient_();
+    const doubleclicksearch = await this.getApiClient();
     const { status, data } = await doubleclicksearch.reports.request({ requestBody });
     if (status >= 200 && status < 300) {
       return data.id;
@@ -341,7 +325,7 @@ class DoubleClickSearch {
    * }>>}
    */
   async getReportUrls(reportId) {
-    const doubleclicksearch = await this.getApiClient_();
+    const doubleclicksearch = await this.getApiClient();
     const { status, data } = await doubleclicksearch.reports.get({ reportId });
     switch (status) {
       case 200:
@@ -367,11 +351,11 @@ class DoubleClickSearch {
    * @return {!Promise<string>}
    */
   async getReportFile(reportId, reportFragment) {
-    const doubleclicksearch = await this.getApiClient_();
+    const doubleclicksearch = await this.getApiClient();
     const response = await doubleclicksearch.reports.getFile(
         {reportId, reportFragment});
     if (response.status === 200) {
-      return Buffer.from(await response.data.arrayBuffer()).toString();
+      return response.data;
     }
     const errorMsg =
         `Error in get file from reports: ${reportFragment}@${reportId}`;
@@ -387,7 +371,7 @@ class DoubleClickSearch {
    * @return {!Promise<ReadableStream>}
    */
   async getReportFileStream(url) {
-    const auth = await this.getAuth_();
+    const auth = await this.getAuth();
     const headers = await auth.getRequestHeaders();
     const response = await request({
       method: 'GET',

package/src/apis/google_ads_api.js

@@ -22,7 +22,7 @@
 
 const { Transform } = require('stream');
 const lodash = require('lodash');
-
+const { request: gaxiosRequest } = require('gaxios');
 const {
   ConversionAdjustmentUploadServiceClient,
   ConversionUploadServiceClient,
@@ -33,6 +33,8 @@ const {
   UserListServiceClient,
   protos: { google: { ads: { googleads } } },
 } = require('google-ads-nodejs-client');
+
+const API_VERSION = Object.keys(googleads)[0];
 const {
   common: {
     Consent,
@@ -88,7 +90,7 @@ const {
     UserListTypeEnum: { UserListType },
     CustomerMatchUploadKeyTypeEnum: { CustomerMatchUploadKeyType },
   },
-} = googleads.v16;
+} = googleads[API_VERSION];
 
 const AuthClient = require('./auth_client.js');
 const {
@@ -99,10 +101,12 @@ const {
   changeObjectNamingFromSnakeToLowerCamel,
   changeObjectNamingFromLowerCamelToSnake,
 } = require('../components/utils.js');
+const { getCleanCid, RestSearchStreamTransform }
+  = require('./base/ads_api_common.js');
 
 /** @type {!ReadonlyArray<string>} */
 const API_SCOPES = Object.freeze(['https://www.googleapis.com/auth/adwords']);
-
+const API_ENDPOINT = 'https://googleads.googleapis.com';
 /**
  * List of properties that will be taken from the data file as elements of a
  * conversion or a conversion adjustment.
@@ -257,6 +261,9 @@ let ConversionConfig;
  * If audience listId is not present, 'listName' and 'uploadKeyType' need to
  * be there so they can be used to create a customer match user list.
  * operation must be one of 'create' or 'remove'.
+ * `customerMatchUserListMetadata` offers a request level metadata, including
+ * 'consent'. While the top level 'consent', if presents, it will serve as the
+ * fallback value for each UserIdentifier.
  * Should not include `userIdentifierSource` based on:
  * @see https://developers.google.com/google-ads/api/reference/rpc/latest/UserIdentifier
  * @see https://developers.google.com/google-ads/api/reference/rpc/latest/UserDataOperation
@@ -267,6 +274,7 @@ let ConversionConfig;
  *   listId: (string|undefined),
  *   listName: (string|undefined),
  *   uploadKeyType: ('CONTACT_INFO'|'CRM_ID'|'MOBILE_ADVERTISING_ID'|undefined),
+ *   customerMatchUserListMetadata: (undefined|CustomerMatchUserListMetadata),
  *   operation: ('create'|'remove'),
  *   consent: (!Consent),
  * }}
@@ -284,6 +292,9 @@ let CustomerMatchConfig;
  *  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 'CUSTOMER_MATCH_*', `customerMatchUserListMetadata` offers a job
+ * level metadata, including 'consent'. While the top level 'consent',
+ * if presents, it will serve as the fallback value for each UserIdentifier.
  * For job type 'STORE_SALES_UPLOAD_FIRST_PARTY', `storeSalesMetadata` is
  * required to offer StoreSalesMetadata. Besides that, for the store sales data,
  * common data (e.g. `currencyCode`, `conversionAction`) in
@@ -298,6 +309,7 @@ let CustomerMatchConfig;
  *   operation: ('create'|'remove'),
  *   type: !OfflineUserDataJobType,
  *   storeSalesMetadata: (undefined|StoreSalesMetadata),
+ *   customerMatchUserListMetadata: (undefined|CustomerMatchUserListMetadata),
  *   transactionAttribute: (undefined|TransactionAttribute),
  *   userAttribute: (undefined|UserAttribute),
  *   userIdentifierSource: (!UserIdentifierSource|undefined),
@@ -356,7 +368,7 @@ class GoogleAdsApi {
   async getReport(customerId, loginCustomerId, query) {
     const request = new SearchGoogleAdsRequest({
       query,
-      customerId: this.getCleanCid_(customerId),
+      customerId: getCleanCid(customerId),
     });
     return this.getReport_(request, loginCustomerId, true);
   }
@@ -382,7 +394,7 @@ class GoogleAdsApi {
     const request = new SearchGoogleAdsRequest(
       Object.assign({
         query,
-        customerId: this.getCleanCid_(customerId),
+        customerId: getCleanCid(customerId),
         pageSize: 10000,
       }, options)
     );
@@ -413,7 +425,6 @@ class GoogleAdsApi {
     return result;
   }
 
-  //TODO: Test a big report see how the event 'data' is triggered
   /**
    * Gets stream report of a given Customer account. The stream will send
    * `SearchGoogleAdsResponse` objects with the event 'data'.
@@ -426,7 +437,7 @@ class GoogleAdsApi {
     const client = await this.getGoogleAdsServiceClient_();
     const request = new SearchGoogleAdsRequest({
       query,
-      customerId: this.getCleanCid_(customerId),
+      customerId: getCleanCid(customerId),
     });
     const callOptions = this.getCallOptions_(loginCustomerId);
     const response = await client.searchStream(request, callOptions);
@@ -441,11 +452,11 @@ class GoogleAdsApi {
    * @param {string} customerId
    * @param {string} loginCustomerId Login customer account ID (Mcc Account id).
    * @param {string} query A Google Ads Query string.
-   * @param {boolean} outputSnake Output JSON objects in snake_case.
-   * @return {!Promise<string>}
+   * @param {boolean} snakeCase Output JSON objects in snake_case.
+   * @return {!Promise<stream>}
    */
   async cleanedStreamReport(customerId, loginCustomerId, query,
-    outputSnake = false) {
+    snakeCase = false) {
     const cleanReportStream = new Transform({
       writableObjectMode: true,
       transform(chunk, encoding, callback) {
@@ -454,7 +465,7 @@ class GoogleAdsApi {
           return path.split('.').map(changeNamingFromSnakeToLowerCamel).join('.');
         });
         const extractor = extractObject(camelPaths);
-        const results = outputSnake
+        const results = snakeCase
           ? chunk.results.map(extractor).map(changeObjectNamingFromLowerCamelToSnake)
           : chunk.results.map(extractor);
         // Add a line break after each chunk to keep files in proper format.
@@ -467,25 +478,69 @@ class GoogleAdsApi {
       .pipe(cleanReportStream);
   }
 
+  /**
+   * Gets the report stream through REST interface.
+   * @param {string} customerId
+   * @param {string} loginCustomerId Login customer account ID (Mcc Account id).
+   * @param {string} query A Google Ads Query string.
+   * @return {!Promise<stream>}
+   */
+  async restStreamReport(customerId, loginCustomerId, query) {
+    await this.authClient.prepareCredentials();
+    const headers = Object.assign(
+      await this.authClient.getDefaultAuth().getRequestHeaders(),
+      this.getGoogleAdsHeaders_(loginCustomerId)
+    );
+    const options = {
+      baseURL: `${API_ENDPOINT}/${API_VERSION}/`,
+      url: `customers/${getCleanCid(customerId)}/googleAds:searchStream`,
+      headers,
+      data: { query },
+      method: 'POST',
+      responseType: 'stream',
+    };
+    const response = await gaxiosRequest(options);
+    return response.data;
+  }
+
+  /**
+   * Gets the report stream through REST interface.
+   * Based on the `fieldMask` in the response to filter out
+   * selected fields of the report and returns an array of JSON format strings
+   * with the delimit of a line breaker.
+   * @param {string} customerId
+   * @param {string} loginCustomerId Login customer account ID (Mcc Account id).
+   * @param {string} query A Google Ads Query string.
+   * @param {boolean} snakeCase Output JSON objects in snake_case.
+   * @return {!Promise<stream>}
+   */
+  async cleanedRestStreamReport(customerId, loginCustomerId, query,
+    snakeCase = false) {
+    const transform = new RestSearchStreamTransform(snakeCase);
+    const stream =
+      await this.restStreamReport(customerId, loginCustomerId, query);
+    return stream.on('error', (error) => transform.emit('error', error))
+      .pipe(transform);
+  }
+
   /**
    * 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',]) {
+  async searchReportField(adFields,
+    metadata = ['name', 'data_type', 'is_repeated', 'type_url',]) {
     const client = await this.getGoogleAdsFieldServiceClient_();
     const selectClause = metadata.join(',');
     const fields = adFields.join('","');
     const query = `SELECT ${selectClause} WHERE name IN ("${fields}")`;
     const request = new SearchGoogleAdsFieldsRequest({ query });
-    const callOptions = this.getCallOptions_(loginCustomerId);
+    const callOptions = this.getCallOptions_();
     const [results] = await client.searchGoogleAdsFields(request, callOptions);
     return results;
   }
@@ -569,8 +624,8 @@ class GoogleAdsApi {
     functionName, propertyForDebug) {
     /** @type {!ConversionConfig} */
     const adsConfig = this.getCamelConfig_(conversionConfig);
-    adsConfig.customerId = this.getCleanCid_(customerId);
-    adsConfig.loginCustomerId = this.getCleanCid_(loginCustomerId);
+    adsConfig.customerId = getCleanCid(customerId);
+    adsConfig.loginCustomerId = getCleanCid(loginCustomerId);
     /**
      * Sends a batch of hits to Google Ads API.
      * @param {!Array<string>} lines Data for single request. It should be
@@ -885,7 +940,7 @@ class GoogleAdsApi {
       SELECT user_list.id, user_list.resource_name
       FROM user_list
       WHERE user_list.name = '${listName}'
-        AND customer.id = ${this.getCleanCid_(customerId)}
+        AND customer.id = ${getCleanCid(customerId)}
         AND user_list.type = CRM_BASED
         AND user_list.membership_status = OPEN
         AND user_list.crm_based_user_list.upload_key_type = ${uploadKeyType}
@@ -915,7 +970,7 @@ class GoogleAdsApi {
       crmBasedUserList: { uploadKeyType },
     });
     const request = new MutateUserListsRequest({
-      customerId: this.getCleanCid_(customerId),
+      customerId: getCleanCid(customerId),
       operations: [{ create: userList }],
       validateOnly: this.debugMode, // when true makes no changes
       partialFailure: false, // Simplify error handling in creating userlist
@@ -1021,9 +1076,9 @@ class GoogleAdsApi {
     const operations = userDataList.map(
       (userData) => new UserDataOperation({ [operation]: new UserData(userData) })
     );
-    const metadata = this.buildCustomerMatchUserListMetadata_(customerId, listId);
+    const metadata = this.buildCustomerMatchUserListMetadata_(config);
     const request = new UploadUserDataRequest({
-      customerId: this.getCleanCid_(customerId),
+      customerId: getCleanCid(customerId),
       operations,
       customerMatchUserListMetadata: metadata,
     });
@@ -1035,16 +1090,20 @@ class GoogleAdsApi {
   /**
    * 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
+   * @param {{
+   *     customerId: string,
+   *     listId: string,
+   *     customerMatchUserListMetadata: undefined|!CustomerMatchUserListMetadata
+   *   }}  config Configuration for CustomerMatchUserListMetadata
    * @return {!CustomerMatchUserListMetadata}
    * @private
    */
-  buildCustomerMatchUserListMetadata_(customerId, userListId) {
-    const resourceName = `customers/${customerId}/userLists/${userListId}`;
-    return new CustomerMatchUserListMetadata({
+  buildCustomerMatchUserListMetadata_(config) {
+    const { customerId, listId, customerMatchUserListMetadata } = config;
+    const resourceName = `customers/${customerId}/userLists/${listId}`;
+    return new CustomerMatchUserListMetadata(Object.assign({
       userList: resourceName,
-    });
+    }, customerMatchUserListMetadata));
   }
 
   /**
@@ -1090,8 +1149,7 @@ class GoogleAdsApi {
     const jobData = { type };
     // https://developers.google.com/google-ads/api/rest/reference/rest/latest/OfflineUserDataJobs?hl=en#CustomerMatchUserListMetadata
     if (type.startsWith('CUSTOMER_MATCH')) {
-      const metadata = this.buildCustomerMatchUserListMetadata_(customerId,
-        listId);
+      const metadata = this.buildCustomerMatchUserListMetadata_(config);
       jobData.customerMatchUserListMetadata = metadata;
       // https://developers.google.com/google-ads/api/rest/reference/rest/latest/OfflineUserDataJob?hl=en#StoreSalesMetadata
     } else if (type.startsWith('STORE_SALES')) {
@@ -1105,7 +1163,7 @@ class GoogleAdsApi {
     }
     const job = new OfflineUserDataJob(jobData);
     const request = new CreateOfflineUserDataJobRequest({
-      customerId: this.getCleanCid_(customerId),
+      customerId: getCleanCid(customerId),
       job,
       validateOnly: this.debugMode, // when true makes no changes
       enableMatchRateRangePreview: true,
@@ -1258,16 +1316,6 @@ class GoogleAdsApi {
     }
   }
 
-  /**
-   * Returns a integer format CID by removing dashes.
-   * @param {string} cid
-   * @return {string}
-   * @private
-   */
-  getCleanCid_(cid) {
-    return cid.toString().replace(/-/g, '');
-  }
-
   /**
    * Historically, we used a 3rd party library that adopted snake naming
    * convention as the protobuf files and API documents. However, the
@@ -1289,10 +1337,11 @@ class GoogleAdsApi {
    * @private
    */
   getGoogleAdsHeaders_(loginCustomerId) {
-    return {
-      "developer-token": this.developerToken,
-      "login-customer-id": loginCustomerId,
-    };
+    const headers = { 'developer-token': this.developerToken };
+    if (loginCustomerId) {
+      headers['login-customer-id'] = getCleanCid(loginCustomerId);
+    }
+    return headers;
   }
 
   /**
@@ -1305,7 +1354,7 @@ class GoogleAdsApi {
   getCallOptions_(loginCustomerId) {
     return {
       otherArgs: {
-        headers: this.getGoogleAdsHeaders_(this.getCleanCid_(loginCustomerId)),
+        headers: this.getGoogleAdsHeaders_(loginCustomerId),
       },
     };
   }

package/src/apis/index.js

@@ -88,7 +88,6 @@ exports.searchads = require('./search_ads.js');
 /**
  * APIs integration class for DoubleClick BidManager (DV360).
  * @const {{
- *   QueryResource:!QueryResource,
  *   DoubleClickBidManager:!DoubleClickBidManager,
  * }}
  */