Add Single Row with Google Sheets API on New App Relationship Events from Shopify Partner API

Pipedream makes it easy to connect APIs for Google Sheets, Shopify Partner and 2,400+ other apps remarkably fast.

Trigger workflow on

New App Relationship Events from the Shopify Partner API

Next, do this

Add Single Row with the Google Sheets API

No credit card required

▶

Watch us build a workflow

8 min

Watch now ➜

Trusted by 1,000,000+ developers from startups to Fortune 500 companies

Developers ♥ Pipedream

Getting Started#

This integration creates a workflow with a Shopify Partner trigger and Google Sheets action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Select this integration
Configure the New App Relationship Events trigger
1. Connect your Shopify Partner account
2. Configure timer
3. Configure Shopify App ID
4. Optional- Configure occurredAtMin
5. Optional- Configure occurredAtMax
6. Optional- Configure Maximum records to query per run
7. Select a Pagination direction
Configure the Add Single Row action
1. Connect your Google Sheets account
2. Optional- Select a Drive
3. Select a Spreadsheet
4. Select one or more Worksheet(s)
5. Configure Does the first row of the sheet have headers?
Deploy the workflow
Send a test event to validate your setup
Turn on the trigger

Details#

This integration uses pre-built, source-available components from Pipedream's GitHub repo. These components are developed by Pipedream and the community, and verified and maintained by Pipedream.

To contribute an update to an existing component or create a new component, create a PR on GitHub. If you're new to Pipedream component development, you can start with quickstarts for trigger span and action development, and then review the component API reference.

Trigger#

New App Relationship Events on Shopify Partner

Description:Emit new events when new shops installs, uninstalls, subscribes or unsubscribes your app.

Version:0.1.3

Key:shopify_partner-new-app-relationship-events

View on GitHub

Shopify Partner Overview#

The Shopify Partner API lets you tap into a comprehensive suite of features to manage and analyze multiple Shopify stores. You can automate tasks like creating development stores, adding collaborators, tracking payouts, and more. This API serves as a powerful tool for developers, agencies, and freelancers who manage multiple Shopify shops for their clients. Through Pipedream, you can effortlessly integrate Shopify Partner API with other services to create tailored, efficient workflows that save time and enhance productivity.

Trigger Code#

import common from "../../common/common.mjs";
import shopify from "../../shopify_partner.app.mjs";
import getAppRelationshipEventsBackwards from "../../common/queries/getAppRelationshipEventsBackwards.mjs";
import getAppRelationshipEventsForwards from "../../common/queries/getAppRelationshipEventsForwards.mjs";

export default {
  key: "shopify_partner-new-app-relationship-events",
  name: "New App Relationship Events",
  type: "source",
  version: "0.1.3",
  description:
    "Emit new events when new shops installs, uninstalls, subscribes or unsubscribes your app.",
  ...common,
  props: {
    ...common.props,
    db: "$.service.db",
    appId: {
      propDefinition: [
        shopify,
        "appId",
      ],
    },
    occurredAtMin: {
      propDefinition: [
        shopify,
        "occurredAtMin",
      ],
    },
    occurredAtMax: {
      propDefinition: [
        shopify,
        "occurredAtMax",
      ],
    },
    recordsPerRun: {
      propDefinition: [
        shopify,
        "recordsPerRun",
      ],
    },
    paginationDirection: {
      propDefinition: [
        shopify,
        "paginationDirection",
      ],
    },
  },
  async run() {
    const {
      appId,
      occurredAtMin,
      occurredAtMax,
      db,
      paginationDirection,
      recordsPerRun,
    } = this;

    const variables = {
      appId: `gid://partners/App/${appId}`,
    };
    if (occurredAtMin) {
      variables.occurredAtMin = occurredAtMin.trim();
    }
    if (occurredAtMax) {
      variables.occurredAtMax = occurredAtMax.trim();
    }

    console.log("Querying events");

    await this.shopify.query({
      db,
      key: "shopify_partner-relationship-events",
      query:
        this.paginationDirection === "backward" ||
        !this.db.get("shopify_partner-relationship-events") // on the first run, pull records from present day
          ? getAppRelationshipEventsBackwards
          : getAppRelationshipEventsForwards,
      variables,
      handleEmit: (data) => {
        data.app.events.edges.map(({ node: { ...event } }) => {
          this.$emit(event, {
            id: event.occurredAt,
            summary: `${event.shop.name} (${event.shop.myshopifyDomain}) installed ${event.app.name}`,
          });
        });
      },
      getCursor: (data) => {
        const edges = data?.app?.events?.edges || [];
        if (this.paginationDirection === "backward") {
          const last = edges[edges.length - 1];
          console.log("Last event in batch: ", last);
          return last?.cursor;
        } else {
          const [
            first,
          ] = edges;
          console.log("First event in batch: ", first);
          return first?.cursor;
        }
      },
      hasNextPagePath:
        this.paginationDirection === "forward" ||
        !this.db.get("shopify_partner-relationship-events")
          ? "app.events.pageInfo.hasNextPage"
          : "app.events.pageInfo.hasPreviousPage",
      paginationDirection,
      recordsPerRun,
    });
  },
};

Trigger Configuration#

This component may be configured based on the props defined in the component code. Pipedream automatically prompts for input values in the UI and CLI.

Label	Prop	Type	Description
Shopify Partner	`shopify`	`app`	This component uses the Shopify Partner app.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
timer	`timer`	`$.interface.timer`	API Polling Frequency
Shopify App ID	`appId`	`string`	Open your app in the partner portal, and look at the URL to find its ID. If your URL is https://partners.shopify.com/3027494/apps/51358007297/overview, enter `51358007297` here.
occurredAtMin	`occurredAtMin`	`string`	Only include events after this specific time (ISO timestamp)
occurredAtMax	`occurredAtMax`	`string`	Only include events up to this specific time (ISO timestamp)
Maximum records to query per run	`recordsPerRun`	`integer`	Number of records to retrieve per run
Pagination direction	`paginationDirection`	`string`	Select a value from the drop down menu:`{ "label": "Forwards", "value": "forward" }{ "label": "Backwards", "value": "backward" }`

Trigger Authentication#

Shopify Partner uses API keys for authentication. When you connect your Shopify Partner account, Pipedream securely stores the keys so you can easily authenticate to Shopify Partner APIs in both code and no-code steps.

Create an API Key

In order to authorize Pipedream to access your Shopify Partner Account, you will need to generate a new API key for Pipedream to use on your behalf.

First, create an API client in your Shopify Partner account.

Make sure to include these scopes:

View financials
Manage apps

You will use this API key to authenticate your Pipedream workflows with Shopify Partners.

Open API key management in the Shopify Partner Portal

Create a new API key

Create API key

Enter in "Pipedream" as the name and select the appropriate scopes, then click "Save" to finish

Enter in Pipedream API key options

Find your Organization ID

After you log into the Shopify Partner portal, look at the URL for your organization ID

Find your Shopify Partner Organization ID

Find your App ID

After opening your app in the partner portal, look in the URL to find it's ID:

Find your Shopify App ID

About Shopify Partner#

Shopify Partner API connection. Listen to events like installs, uninstalls, charges & transactions.

Action#

Add Single Row on Google Sheets

Description:Add a single row of data to Google Sheets. [See the documentation](https://developers.google.com/sheets/api/reference/rest/v4/spreadsheets.values/append)

Version:2.1.11

Key:google_sheets-add-single-row

View on GitHub

Google Sheets Overview#

The Google Sheets API allows for the creation, reading, updating, and deletion of data within Google Sheets, enabling a robust platform for spreadsheet management and data manipulation. Through Pipedream, you can craft serverless workflows that respond to various triggers, such as webhook events, emails, or scheduled times, to interact with Google Sheets. This synergy can automate reporting, synchronize data across applications, manage inventory, track leads in a CRM, or even conduct survey analysis by updating and retrieving sheet data on the fly.

Action Code#

import common from "../common/worksheet.mjs";
import { ConfigurationError } from "@pipedream/platform";
import { parseArray } from "../../common/utils.mjs";
import { isDynamicExpression } from "../common/worksheet.mjs";

const { googleSheets } = common.props;

export default {
  ...common,
  key: "google_sheets-add-single-row",
  name: "Add Single Row",
  description: "Add a single row of data to Google Sheets. [See the documentation](https://developers.google.com/sheets/api/reference/rest/v4/spreadsheets.values/append)",
  version: "2.1.11",
  type: "action",
  props: {
    googleSheets,
    drive: {
      propDefinition: [
        googleSheets,
        "watchedDrive",
      ],
    },
    sheetId: {
      propDefinition: [
        googleSheets,
        "sheetID",
        (c) => ({
          driveId: googleSheets.methods.getDriveId(c.drive),
        }),
      ],
      reloadProps: true,
    },
    worksheetId: {
      propDefinition: [
        googleSheets,
        "worksheetIDs",
        (c) => ({
          sheetId: c.sheetId?.value || c.sheetId,
        }),
      ],
      description: "Select a worksheet or enter a custom expression. When referencing a spreadsheet dynamically, you must provide a custom expression for the worksheet.",
      async options({ sheetId }) {
        // If sheetId is a dynamic reference, don't load options
        if (isDynamicExpression(sheetId)) {
          return [];
        }

        // Otherwise, call the original options function with the correct context
        const origOptions = googleSheets.propDefinitions.worksheetIDs.options;
        return origOptions.call(this, {
          sheetId,
        });
      },
      reloadProps: true,
    },
    hasHeaders: common.props.hasHeaders,
  },
  async additionalProps() {
    const {
      sheetId,
      worksheetId,
      hasHeaders,
    } = this;

    // If using dynamic expressions for either sheetId or worksheetId, return only array input
    if (isDynamicExpression(sheetId) || isDynamicExpression(worksheetId)) {
      return {
        myColumnData: {
          type: "string[]",
          label: "Values",
          description: "Provide a value for each cell of the row. Google Sheets accepts strings, numbers and boolean values for each cell. To set a cell to an empty value, pass an empty string.",
        },
      };
    }

    const props = {};
    if (hasHeaders) {
      try {
        const worksheet = await this.getWorksheetById(sheetId, worksheetId);
        const { values } = await this.googleSheets.getSpreadsheetValues(sheetId, `${worksheet?.properties?.title}!1:1`);

        if (!values?.[0]?.length) {
          throw new ConfigurationError("Could not find a header row. Please either add headers and click \"Refresh fields\" or set 'Does the first row of the sheet have headers?' to false.");
        }

        for (let i = 0; i < values[0]?.length; i++) {
          props[`col_${i.toString().padStart(4, "0")}`] = {
            type: "string",
            label: values[0][i],
            optional: true,
          };
        }
        props.allColumns = {
          type: "string",
          hidden: true,
          default: JSON.stringify(values),
        };
      } catch (err) {
        console.error("Error fetching headers:", err);
        // Fallback to basic column input if headers can't be fetched
        return {
          headerError: {
            type: "string",
            label: "Header Fetch Error",
            description: `Unable to fetch headers: ${err.message}. Using simple column input instead.`,
            optional: true,
            hidden: true,
          },
          myColumnData: {
            type: "string[]",
            label: "Values",
            description: "Provide a value for each cell of the row. Google Sheets accepts strings, numbers and boolean values for each cell. To set a cell to an empty value, pass an empty string.",
          },
        };
      }
    } else {
      props.myColumnData = {
        type: "string[]",
        label: "Values",
        description: "Provide a value for each cell of the row. Google Sheets accepts strings, numbers and boolean values for each cell. To set a cell to an empty value, pass an empty string.",
      };
    }
    return props;
  },
  async run({ $ }) {
    const {
      sheetId,
      worksheetId,
    } = this;

    const { name: sheetName } = await this.googleSheets.getFile(sheetId, {
      fields: "name",
    });

    const worksheet = await this.getWorksheetById(sheetId, worksheetId);

    let cells;
    if (this.hasHeaders
      && !isDynamicExpression(sheetId)
      && !isDynamicExpression(worksheetId)
      && this.allColumns
    ) {
      const rows = JSON.parse(this.allColumns);
      const [
        headers,
      ] = rows;
      cells = headers
        .map((_, i) => `col_${i.toString().padStart(4, "0")}`)
        .map((column) => this[column] ?? "");
    } else {
      // For dynamic references or no headers, use the array input
      cells = this.googleSheets.sanitizedArray(this.myColumnData);
    }

    // Validate input
    if (!cells || !cells.length) {
      throw new ConfigurationError("Please enter an array of elements in `Cells / Column Values`.");
    }
    cells = parseArray(cells);
    if (!cells) {
      throw new ConfigurationError("Cell / Column data is not an array. Please enter an array of elements in `Cells / Column Values`.");
    } else if (Array.isArray(cells[0])) {
      throw new ConfigurationError("Cell / Column data is a multi-dimensional array. A one-dimensional is expected. If you're trying to send multiple rows to Google Sheets, search for the action to add multiple rows to Sheets.");
    }

    const {
      arr: sanitizedCells,
      convertedIndexes,
    } = this.googleSheets.arrayValuesToString(cells);

    const data = await this.googleSheets.addRowsToSheet({
      spreadsheetId: sheetId,
      range: worksheet?.properties?.title,
      rows: [
        sanitizedCells,
      ],
    });

    let summary = `Added 1 row to [${sheetName || sheetId} (${data.updatedRange})](https://docs.google.com/spreadsheets/d/${sheetId}).`;
    if (convertedIndexes.length > 0) {
      summary += " We detected something other than a string/number/boolean in at least one of the fields and automatically converted it to a string.";
    }
    $.export("$summary", summary);

    return data;
  },
};

Action Configuration#

This component may be configured based on the props defined in the component code. Pipedream automatically prompts for input values in the UI.

Label	Prop	Type	Description
Google Sheets	`googleSheets`	`app`	This component uses the Google Sheets app.
Drive	`drive`	`string`	Select a value from the drop down menu.
Spreadsheet	`sheetId`	`string`	Select a value from the drop down menu.
Worksheet(s)	`worksheetId`	`string[]`	Select a value from the drop down menu.
Does the first row of the sheet have headers?	`hasHeaders`	`boolean`	If the first row of your document has headers, we'll retrieve them to make it easy to enter the value for each column. Note: When using a dynamic reference for the worksheet ID (e.g. `{{steps.foo.$return_value}}`), this setting is ignored.

Action Authentication#

Google Sheets uses OAuth authentication. When you connect your Google Sheets account, Pipedream will open a popup window where you can sign into Google Sheets and grant Pipedream permission to connect to your account. Pipedream securely stores and automatically refreshes the OAuth tokens so you can easily authenticate any Google Sheets API.

Pipedream requests the following authorization scopes when you connect your account:

emailprofilehttps://www.googleapis.com/auth/drive

About Google Sheets#

Use Google Sheets to create and edit online spreadsheets. Get insights together with secure sharing in real-time and from any device.

More Ways to Connect Google Sheets + Shopify Partner#

Other Popular Integrations#

Verify Webhook with Shopify Partner API on New Updates (Shared Drive, Instant) from Google Sheets API

Google Sheets + Shopify Partner