@google-cloud/nodejs-common 2.0.4-alpha → 2.0.6-alpha

package/src/apis/index.js

@@ -77,6 +77,14 @@ exports.spreadsheets = require('./spreadsheets.js');
  */
 exports.doubleclicksearch = require('./doubleclick_search.js');
 
+/**
+ * APIs integration class for Search Ads 360 Reporting.
+ * @const {{
+*   SearchAds:!SearchAds,
+* }}
+*/
+exports.searchads = require('./search_ads.js');
+
 /**
  * APIs integration class for DoubleClick BidManager (DV360).
  * @const {{
@@ -104,6 +112,18 @@ exports.bigquery = require('./bigquery.js');
  */
 exports.googleads = require('./google_ads.js');
 
+/**
+ * APIs integration class for Google Ads with Google API library.
+ * @const {{
+*   GoogleAdsApi:!GoogleAdsApi,
+*   ConversionConfig:!ConversionConfig,
+*   CustomerMatchConfig: !CustomerMatchConfig,
+*   OfflineUserDataJobConfig: !OfflineUserDataJobConfig,
+*   CustomerMatchRecord: !CustomerMatchRecord,
+* }}
+*/
+exports.googleadsapi = require('./google_ads_api.js');
+
 /**
  * APIs integration class for Ads Data Hub.
  * @const {{

package/src/apis/search_ads.js

@@ -0,0 +1,171 @@
+// 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 Search Ads 360 Reporting on GoogleAPI Client Library.
+ */
+
+'use strict';
+
+const { google } = require('googleapis');
+const AuthClient = require('./auth_client.js');
+const { getLogger } = require('../components/utils.js');
+
+const API_SCOPES = Object.freeze([
+  'https://www.googleapis.com/auth/doubleclicksearch',
+]);
+const API_VERSION = 'v0';
+
+/**
+ * Search Ads 360 Reporting API stub.
+ * See: https://developers.google.com/search-ads/reporting/api/reference/release-notes
+ */
+class SearchAds {
+
+  /**
+   * @constructor
+   * @param {!Object<string,string>=} env The environment object to hold env
+   *     variables.
+   */
+  constructor(env = process.env) {
+    this.authClient = new AuthClient(API_SCOPES, env);
+    this.logger = getLogger('API.SA');
+  }
+
+  /**
+   * Prepares the Search Ads 360 Reporting API instance.
+   * OAuth 2.0 application credentials is required for calling this API.
+   * For Search Ads Reporting API calls made by a manager to a client account,
+   * a HTTP header named `login-customer-id` is required in the request. This
+   * value represents the Search Ads 360 customer ID of the manager making the
+   * API call. Be sure to remove any hyphens (—), for example: 1234567890, not
+   * 123-456-7890.
+   * @see https://developers.google.com/search-ads/reporting/api/reference/rest/auth
+   * @return {!google.searchads360}
+   * @private
+   */
+  async getApiClient_(loginCustomerId) {
+    this.logger.debug(`Initialized Search Ads reporting instance for ${loginCustomerId}`);
+    this.searchads360 = google.searchads360({
+      version: API_VERSION,
+      auth: await this.getAuth_(),
+      headers: { 'login-customer-id': loginCustomerId },
+    });
+    return this.searchads360;
+  }
+
+  /**
+   * 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;
+  }
+
+  /**
+   * Returns all rows that match the search stream query.
+   * The streamed content is not NDJSON format, but one JSON object with the
+   * property `results`. The whole JSON string can be parsed to an object and
+   * the `results` be extracted and converted to NDJSON lines. If the report
+   * is too large to be handled in this way, a possible solution is to parse
+   * the string directly to get the content of `results`.
+   * @see https://developers.google.com/search-ads/reporting/api/reference/rest/v0/customers.searchAds360/searchStream
+   * @param {string} customerId
+   * @param {string} loginCustomerId Login customer account ID (Mcc Account id).
+   * @param {string} query
+   * @return {!ReadableStream}
+   */
+  async streamReport(customerId, loginCustomerId, query) {
+    const searchads = await this.getApiClient_(loginCustomerId);
+    const response = await searchads.customers.searchAds360.search({
+      customerId,
+      requestBody: { query },
+    }, { responseType: 'stream' });
+    return response.data;
+  }
+
+  /**
+   * Gets a report synchronously from a given Customer account.
+   * This is for test as it does not handle page token. For product env, use
+   * function `streamReport`.
+   * @see https://developers.google.com/search-ads/reporting/api/reference/rest/v0/customers.searchAds360/search#request-body
+   * @param {string} customerId
+   * @param {string} loginCustomerId Login customer account ID (Mcc Account id).
+   * @param {string} query
+   * @return {!SearchAds360Field}
+   * @see https://developers.google.com/search-ads/reporting/api/reference/rest/v0/searchAds360Fields#SearchAds360Field
+   */
+  async getReport(customerId, loginCustomerId, query) {
+    const searchads = await this.getApiClient_(loginCustomerId);
+    const response = await searchads.customers.searchAds360.search({
+      customerId,
+      requestBody: { query },
+    });
+    return response.data.results;
+  }
+
+  /**
+   * Returns the requested field or resource (artifact) used by SearchAds360Service.
+   * This service doesn't require `login-customer-id` HTTP header.
+   * @see https://developers.google.com/search-ads/reporting/api/reference/rest/v0/searchAds360Fields/get
+   * @param {string} resourceName
+   * @return {!SearchAds360Field}
+   * @see https://developers.google.com/search-ads/reporting/api/reference/rest/v0/searchAds360Fields#SearchAds360Field
+   */
+  async getReportField(resourceName) {
+    const searchads = await this.getApiClient_();
+    const response = await searchads.searchAds360Fields.get({ resourceName });
+    return response.data;
+  }
+
+  /**
+   * Returns all the custom columns associated with the customer in full detail.
+   * @see https://developers.google.com/search-ads/reporting/api/reference/rest/v0/customers.customColumns/list
+   * @param {string} customerId - The ID of the customer.
+   * @param {string} loginCustomerId - The ID of the manager.
+   * @return {!Array<CustomColumn>}
+   * @see https://developers.google.com/search-ads/reporting/api/reference/rest/v0/customers.customColumns#CustomColumn
+   */
+  async listCustomColumns(customerId, loginCustomerId) {
+    const searchads = await this.getApiClient_(loginCustomerId);
+    const response = await searchads.customers.customColumns.list({ customerId });
+    return response.data.customColumns;
+  }
+
+  /**
+   * Returns the requested custom column in full detail.
+   * @see https://developers.google.com/search-ads/reporting/api/reference/rest/v0/customers.customColumns/get
+   * @param {string} columnId - The ID of the customColumn.
+   * @param {string} customerId - The ID of the customer.
+   * @param {string} loginCustomerId - The ID of the manager.
+   * @return {!CustomColumn}
+   * @see https://developers.google.com/search-ads/reporting/api/reference/rest/v0/customers.customColumns#CustomColumn
+   */
+  async getCustomColumn(columnId, customerId, loginCustomerId) {
+    const resourceName = `customers/${customerId}/customColumns/${columnId}`;
+    const searchads = await this.getApiClient_(loginCustomerId);
+    const response = await searchads.customers.customColumns.get({ resourceName });
+    return response.data;
+  }
+
+}
+
+module.exports = {
+  SearchAds,
+  API_VERSION,
+  API_SCOPES,
+};

package/src/components/storage.js

@@ -179,7 +179,7 @@ class StorageFile {
         .on('finish', async () => {
           const [{ contentType }] = await this.file.getMetadata();
           const [file] = await outputFile.setMetadata({ contentType });
-          return file.name;
+          resolve(file.name);
         });
     });
   }

package/src/components/utils.js

@@ -539,6 +539,28 @@ const changeNamingFromSnakeToLowerCamel = (name) => {
       (initial) => initial.substring(1).toUpperCase());
 };
 
+/**
+ * Converts a JSON object which has snake naming convention to lower camel
+ * naming.
+ *
+ * @param {object} obj
+ * @return {object}
+ */
+const changeObjectNamingFromSnakeToLowerCamel = (obj) => {
+  if (Array.isArray(obj)) {
+    return obj.map(changeObjectNamingFromSnakeToLowerCamel);
+  } else if (typeof obj === 'object') {
+    const newObj = {};
+    Object.keys(obj).forEach((key) => {
+      newObj[changeNamingFromSnakeToLowerCamel(key)] =
+        changeObjectNamingFromSnakeToLowerCamel(obj[key]);
+    });
+    return newObj;
+  } else {
+    return obj;
+  }
+}
+
 /**
  * Returns the response data for a HTTP request. It will retry the specific
  * times if there was errors happened.
@@ -584,5 +606,6 @@ module.exports = {
   getObjectByPath,
   changeNamingFromSnakeToUpperCamel,
   changeNamingFromSnakeToLowerCamel,
+  changeObjectNamingFromSnakeToLowerCamel,
   requestWithRetry,
 };