← Google Cloud + Twitter integrations

Advanced Search with Twitter API on New Pub/Sub Messages from Google Cloud API

Pipedream makes it easy to connect APIs for Twitter, Google Cloud and 800+ other apps remarkably fast.

Trigger workflow on
New Pub/Sub Messages from the Google Cloud API
Next, do this
Advanced Search with the Twitter API
No credit card required
Into to Pipedream
Watch us build a workflow
Watch us build a workflow
7 min
Watch now ➜
Trusted by 250,000+ developers from startups to Fortune 500 companies:
Trusted by 250,000+ developers from startups to Fortune 500 companies

Developers Pipedream

Getting Started

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

  1. Select this integration
  2. Configure the New Pub/Sub Messages trigger
    1. Connect your Google Cloud account
    2. Select a Type
  3. Configure the Advanced Search action
    1. Connect your Twitter account
    2. Configure Search Term
    3. Optional- Select a Result Type
    4. Optional- Select a Retweets
    5. Optional- Select a Replies
    6. Optional- Select one or more Languages
    7. Optional- Configure Locale
    8. Optional- Configure Geocode
    9. Optional- Configure Since ID
    10. Optional- Configure Enrich Tweets
    11. Optional- Configure Count (advanced)
    12. Optional- Configure Max API Requests per Execution (advanced)
  4. Deploy the workflow
  5. Send a test event to validate your setup
  6. Turn on the trigger

Details

This integration uses pre-built, open source 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

Description:Emit new Pub/Sub topic in your GCP account. Messages published to this topic are emitted from the Pipedream source.
Version:0.1.4
Key:google_cloud-new-pubsub-messages

Trigger Code

import { PubSub } from "@google-cloud/pubsub";
import googleCloud from "../../google_cloud.app.mjs";

export default {
  key: "google_cloud-new-pubsub-messages",
  name: "New Pub/Sub Messages",
  description: "Emit new Pub/Sub topic in your GCP account. Messages published to this topic are emitted from the Pipedream source.",
  version: "0.1.4",
  type: "source",
  dedupe: "unique", // Dedupe on Pub/Sub message ID
  props: {
    googleCloud,
    http: "$.interface.http",
    db: "$.service.db",
    topicType: {
      type: "string",
      label: "Type",
      description: "Do you have an existing Pub/Sub topic, or would you like to create a new one?",
      options: [
        "existing",
        "new",
      ],
      reloadProps: true,
    },
  },
  async additionalProps() {
    const topic = {
      type: "string",
      label: "Pub/Sub Topic Name",
      description: "Select a Pub/Sub topic from your GCP account to watch",
      options: async () => {
        return this.getTopics();
      },
    };
    if (this.topicType === "new") {
      topic.description = "**Pipedream will create a Pub/Sub topic with this name in your account**, converting it to a [valid Pub/Sub topic name](https://cloud.google.com/pubsub/docs/admin#resource_names).";
      delete topic.options;
    }
    return {
      topic,
    };
  },
  methods: {
    _getTopicName() {
      return this.db.get("topicName");
    },
    _setTopicName(topicName) {
      this.db.set("topicName", topicName);
    },
    _getSubscriptionName() {
      return this.db.get("subscriptionName");
    },
    _setSubscriptionName(subscriptionName) {
      this.db.set("subscriptionName", subscriptionName);
    },
    async getTopics() {
      const sdkParams = this.googleCloud.sdkParams();
      const pubSubClient = new PubSub(sdkParams);
      const topics = (await pubSubClient.getTopics())[0];
      if (topics.length > 0) {
        return topics.map((topic) => topic.name);
      }
      return [];
    },
    convertNameToValidPubSubTopicName(name) {
      // For valid names, see https://cloud.google.com/pubsub/docs/admin#resource_names
      return name
        // Must not start with `goog`. We add a `pd-` at the beginning if that's the case.
        .replace(/(^goog.*)/g, "pd-$1")
        // Must start with a letter, otherwise we add `pd-` at the beginning.
        .replace(/^(?![a-zA-Z]+)/, "pd-")
        // Only certain characters are allowed, the rest will be replaced with a `-`.
        .replace(/[^a-zA-Z0-9_\-.~+%]+/g, "-");
    },
  },
  hooks: {
    async activate() {
      const sdkParams = this.googleCloud.sdkParams();
      const pubSubClient = new PubSub(sdkParams);

      const currentTopic = {
        name: this.topic,
      };
      if (this.topicType === "new") {
        const topicName = this.convertNameToValidPubSubTopicName(this.topic);
        console.log(`Creating Pub/Sub topic ${topicName}`);
        const [
          topic,
        ] = await pubSubClient.createTopic(topicName);
        currentTopic.name = topic.name;
      }
      this._setTopicName(currentTopic.name);

      const pushEndpoint = this.http.endpoint;
      const subscriptionName = this.convertNameToValidPubSubTopicName(pushEndpoint);
      const subscriptionOptions = {
        pushConfig: {
          pushEndpoint,
        },
      };
      console.log(
        `Subscribing this source's URL to the Pub/Sub topic: ${pushEndpoint}
        (under name ${subscriptionName}).`,
      );
      const [
        subscriptionResult,
      ] = await pubSubClient
        .topic(currentTopic.name)
        .createSubscription(subscriptionName, subscriptionOptions);
      this._setSubscriptionName(subscriptionResult.name);
    },
    async deactivate() {
      const sdkParams = this.googleCloud.sdkParams();
      const pubSubClient = new PubSub(sdkParams);

      const subscriptionName = this._getSubscriptionName();
      if (subscriptionName) {
        await pubSubClient.subscription(subscriptionName).delete();
      }

      if (this.topicType === "new") {
        const topicName = this._getTopicName();
        if (topicName) {
          await pubSubClient.topic(topicName).delete();
        }
      }
    },
  },
  async run(event) {
    const {
      data,
      messageId,
      publishTime,
    } = event.body.message;

    if (!data) {
      console.warn("No message present, exiting");
      return;
    }
    const dataString = Buffer.from(data, "base64").toString("utf-8");
    const metadata = {
      id: messageId,
      summary: dataString,
      ts: +new Date(publishTime),
    };

    let dataObj;
    try {
      dataObj = JSON.parse(dataString);
    } catch (err) {
      console.error(
        `Couldn't parse message as JSON. Emitting raw message. Error: ${err}`,
      );
      dataObj = {
        rawMessage: dataString,
      };
    }
    this.$emit(dataObj, metadata);
  },
};

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.
LabelPropTypeDescription
Google CloudgoogleCloudappThis component uses the Google Cloud app.
N/Ahttp$.interface.httpThis component uses $.interface.http to generate a unique URL when the component is first instantiated. Each request to the URL will trigger the run() method of the component.
N/Adb$.service.dbThis component uses $.service.db to maintain state between component invocations.
TypetopicTypestringSelect a value from the drop down menu:existingnew

Trigger Authentication

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

1) Create a service account in GCP and set the permissions you need for Pipedream workflows.

2) Generate a service account key

3) Download the key details in JSON format

4) Open the JSON in a text editor, and copy and paste its contents here.

About Google Cloud

The Google Cloud Platform

Action

Description:Return Tweets that matches your search criteria. [See the docs here](https://developer.twitter.com/en/docs/twitter-api/v1/tweets/search/api-reference/get-search-tweets)
Version:0.0.3
Key:twitter-advanced-search

Action Code

import twitter from "../../twitter.app.mjs";

export default {
  key: "twitter-advanced-search",
  name: "Advanced Search",
  description: "Return Tweets that matches your search criteria. [See the docs here](https://developer.twitter.com/en/docs/twitter-api/v1/tweets/search/api-reference/get-search-tweets)",
  version: "0.0.3",
  type: "action",
  props: {
    db: "$.service.db",
    twitter,
    q: {
      propDefinition: [
        twitter,
        "q",
      ],
    },
    resultType: {
      propDefinition: [
        twitter,
        "resultType",
      ],
    },
    includeRetweets: {
      propDefinition: [
        twitter,
        "includeRetweets",
      ],
    },
    includeReplies: {
      propDefinition: [
        twitter,
        "includeReplies",
      ],
    },
    lang: {
      propDefinition: [
        twitter,
        "lang",
      ],
    },
    locale: {
      propDefinition: [
        twitter,
        "locale",
      ],
    },
    geocode: {
      propDefinition: [
        twitter,
        "geocode",
      ],
    },
    sinceId: {
      propDefinition: [
        twitter,
        "sinceId",
      ],
    },
    enrichTweets: {
      propDefinition: [
        twitter,
        "enrichTweets",
      ],
    },
    count: {
      propDefinition: [
        twitter,
        "count",
      ],
    },
    maxRequests: {
      propDefinition: [
        twitter,
        "maxRequests",
      ],
    },
  },
  async run({ $ }) {
    const {
      lang,
      locale,
      geocode,
      resultType,
      enrichTweets,
      includeReplies,
      includeRetweets,
      sinceId,
      maxRequests,
      count,
      q,
    } = this;

    // run paginated search
    const res = await this.twitter.paginatedSearch({
      $,
      q,
      sinceId,
      lang,
      locale,
      geocode,
      resultType,
      enrichTweets,
      includeReplies,
      includeRetweets,
      maxRequests,
      count,
      limitFirstPage: false,
    });
    $.export("$summary", "Search completed successfully");
    return res;
  },
};

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.

LabelPropTypeDescription
N/Adb$.service.dbThis component uses $.service.db to maintain state between component invocations.
TwittertwitterappThis component uses the Twitter app.
Search Termqstring

Search for keywords star wars, screen names @starwars, or hashtags #starwars. You can also use Twitter's standard search operators.

Result TyperesultTypestringSelect a value from the drop down menu:{ "label": "Recent", "value": "recent" }{ "label": "Popular", "value": "popular" }{ "label": "Mixed", "value": "mixed" }
RetweetsincludeRetweetsstringSelect a value from the drop down menu:{ "label": "Include", "value": "include" }{ "label": "Exclude", "value": "exclude" }{ "label": "Only include retweets", "value": "filter" }
RepliesincludeRepliesstringSelect a value from the drop down menu:{ "label": "Include", "value": "include" }{ "label": "Exclude", "value": "exclude" }{ "label": "Only include replies", "value": "filter" }
Languageslangstring[]Select a value from the drop down menu.
Localelocalestring

Specify the language of the query you are sending (only ja is currently effective). This is intended for language-specific consumers and the default should work in the majority of cases.

Geocodegeocodestring

Returns tweets by users located within a given radius of the given latitude/longitude. The location is preferentially taking from the Geotagging API, but will fall back to their Twitter profile. The parameter value is specified by latitude,longitude,radius, where radius units must be specified as either mi (miles) or km (kilometers). Note that you cannot use the near operator via the API to geocode arbitrary locations; however you can use this geocode parameter to search near geocodes directly.

Since IDsinceIdstring

Returns results with an ID greater than (that is, more recent than) the specified ID. There are limits to the number of Tweets that can be accessed through the API. If the limit of Tweets has occurred since the since_id, the 'since_id` will be forced to the oldest ID available.

Enrich TweetsenrichTweetsboolean

Enrich each Tweet with epoch (milliseconds) and ISO 8601 representations of Twitter's created_at timestamp, the Tweet URL, and the profile URL for the author.

Count (advanced)countinteger

The maximum number of tweets to return per API request (up to 100)

Max API Requests per Execution (advanced)maxRequestsinteger

The maximum number of API requests to make per execution (e.g., multiple requests are required to retrieve paginated results). Note: Twitter rate limits API requests per 15 minute interval.

Action Authentication

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

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

About Twitter

From breaking news and entertainment to sports and politics, get the full story with all the live commentary.

More Ways to Connect Twitter + Google Cloud