Create Post with Google Business Profile API

Pipedream makes it easy to connect APIs for Google Business Profile and 2,400+ other apps remarkably fast.

Trigger workflow on

HTTP requests, schedules and app events

Next, do this

Create Post with the Google Business Profile 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#

Create a workflow to Create Post with the Google Business Profile API. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Configure the Create Post action
1. Connect your Google Business Profile account
2. Select a Account Name
3. Select a Location
4. Select a Topic Type
5. Optional- Configure Language Code
6. Optional- Configure Summary
7. Optional- Configure Call to Action
8. Optional- Configure Event
9. Optional- Configure Media
10. Optional- Select a Media Format
11. Optional- Select a Alert Type
12. Optional- Configure Offer
Select a trigger to run your workflow on HTTP requests, schedules or app events
Deploy the workflow
Send a test event to validate your setup
Turn on the trigger

Integrations#

Create Post with Google Business Profile API on New Requests (Payload Only) from HTTP / Webhook API

HTTP / Webhook + Google Business Profile

Try it

Create Post with Google Business Profile API on New Submission from Typeform API

Typeform + Google Business Profile

Try it

Create Post with Google My Business API on Custom Events from Zoom API

Zoom + Google Business Profile

Try it

Create Post with Google Business Profile API on New Submission (Instant) from Jotform API

Jotform + Google Business Profile

Try it

Create Post with Google Business Profile API on New Scheduled Tasks from Pipedream API

Pipedream + Google Business Profile

Try it

Details#

This is a pre-built, source-available component from Pipedream's GitHub repo. The component is 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.

Create Post on Google Business Profile

Description:Create a new local post associated with a location. [See the documentation](https://developers.google.com/my-business/reference/rest/v4/accounts.locations.localPosts/create)

Version:0.0.2

Key:google_my_business-create-post

View on GitHub

Code#

import { defineAction } from "@pipedream/types";
import { ConfigurationError } from "@pipedream/platform";
import app from "../../app/google_my_business.app.mjs";
import { LOCAL_POST_ALERT_TYPES, LOCAL_POST_TOPIC_TYPES, MEDIA_FORMAT_OPTIONS, } from "../../common/constants.mjs";
const DOCS_LINK = "https://developers.google.com/my-business/reference/rest/v4/accounts.locations.localPosts/create";
export default defineAction({
    key: "google_my_business-create-post",
    name: "Create Post",
    description: `Create a new local post associated with a location. [See the documentation](${DOCS_LINK})`,
    version: "0.0.2",
    type: "action",
    props: {
        app,
        account: {
            propDefinition: [
                app,
                "account",
            ],
        },
        location: {
            propDefinition: [
                app,
                "location",
                ({ account }) => ({
                    account,
                }),
            ],
        },
        topicType: {
            type: "string",
            label: "Topic Type",
            description: "The [topic type of the local post](https://developers.google.com/my-business/reference/rest/v4/accounts.locations.localPosts#LocalPostTopicType), which is used to select different templates to create and render a post.",
            options: LOCAL_POST_TOPIC_TYPES,
        },
        languageCode: {
            type: "string",
            label: "Language Code",
            description: "The language of the local post.",
            optional: true,
        },
        summary: {
            type: "string",
            label: "Summary",
            description: "Description/body of the local post.",
            optional: true,
        },
        callToAction: {
            type: "object",
            label: "Call to Action",
            description: "An action that is performed when the user clicks through the post. [See the documentation for more details](https://developers.google.com/my-business/reference/rest/v4/accounts.locations.localPosts#CallToAction).",
            optional: true,
        },
        event: {
            type: "object",
            label: "Event",
            description: "Event information. Required for topic types **EVENT** and **OFFER**. [See the documentation for more details](https://developers.google.com/my-business/reference/rest/v4/accounts.locations.localPosts#LocalPostEvent).",
            optional: true,
        },
        media: {
            type: "string[]",
            label: "Media",
            description: "The media associated with the post. Each entry is treated as a `sourceUrl` (a publicly accessible URL where the media item can be retrieved from). If included, **Media Format** must also be specified. [See the documentation for more details](https://developers.google.com/my-business/reference/rest/v4/accounts.locations.media#MediaItem)",
            optional: true,
        },
        mediaFormat: {
            type: "string",
            label: "Media Format",
            description: "The format of the media item(s). [See the documentation for more details](https://developers.google.com/my-business/reference/rest/v4/accounts.locations.media#MediaItem.MediaFormat)",
            optional: true,
            options: MEDIA_FORMAT_OPTIONS,
        },
        alertType: {
            type: "string",
            label: "Alert Type",
            description: "The type of alert the post is created for. [See the documentation for more details](https://developers.google.com/my-business/reference/rest/v4/accounts.locations.localPosts#AlertType).",
            optional: true,
            options: LOCAL_POST_ALERT_TYPES,
        },
        offer: {
            type: "object",
            label: "Offer",
            description: "Additional data for offer posts. This should only be set when the topicType is **OFFER**. [See the documentation for more details](https://developers.google.com/my-business/reference/rest/v4/accounts.locations.localPosts#LocalPostOffer).",
            optional: true,
        },
    },
    methods: {
        checkAndParseObject(obj) {
            try {
                return typeof obj === "string"
                    ? JSON.parse(obj)
                    : obj;
            }
            catch (err) {
                throw new ConfigurationError(`**Invalid JSON string** for object prop: "${obj}"`);
            }
        },
    },
    async run({ $ }) {
        const { account, location, topicType, languageCode, summary, media, mediaFormat, alertType, } = this;
        const params = {
            $,
            account,
            location,
            data: {
                topicType,
                languageCode,
                summary,
                callToAction: this.checkAndParseObject(this.callToAction),
                event: this.checkAndParseObject(this.event),
                media: media?.map?.((sourceUrl) => ({
                    sourceUrl,
                    mediaFormat,
                })),
                alertType,
                offer: this.checkAndParseObject(this.offer),
            },
        };
        const response = await this.app.createPost(params);
        $.export("$summary", "Successfully created post");
        return response;
    },
});

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
Google Business Profile	`app`	`app`	This component uses the Google Business Profile app.
Account Name	`account`	`string`	Select a value from the drop down menu.
Location	`location`	`string`	Select a value from the drop down menu.
Topic Type	`topicType`	`string`	Select a value from the drop down menu:`{ "label": "Post contains basic information, like summary and images.", "value": "STANDARD" }{ "label": "Post contains basic information and an event.", "value": "EVENT" }{ "label": "Post contains basic information, an event and offer related content (e.g. coupon code)", "value": "OFFER" }{ "label": "High-priority, and timely announcements related to an ongoing event. These types of posts are not always available for authoring.", "value": "ALERT" }`
Language Code	`languageCode`	`string`	The language of the local post.
Summary	`summary`	`string`	Description/body of the local post.
Call to Action	`callToAction`	`object`	An action that is performed when the user clicks through the post. See the documentation for more details.
Event	`event`	`object`	Event information. Required for topic types EVENT and OFFER. See the documentation for more details.
Media	`media`	`string[]`	The media associated with the post. Each entry is treated as a `sourceUrl` (a publicly accessible URL where the media item can be retrieved from). If included, Media Format must also be specified. See the documentation for more details
Media Format	`mediaFormat`	`string`	Select a value from the drop down menu:`{ "label": "Media item is a photo. In this version, only photos are supported.", "value": "PHOTO" }{ "label": "Media item is a video.", "value": "VIDEO" }`
Alert Type	`alertType`	`string`	Select a value from the drop down menu:`{ "label": "No alert is specified.", "value": "ALERT_TYPE_UNSPECIFIED" }{ "label": "Alerts related to the 2019 Coronavirus Disease pandemic. Covid posts only support a summary field and a call to action field. When these alerts are no longer relevant, new Alert post creation for type COVID-19 will be disabled. However, merchant will still be able to manage their existing COVID-19 posts.", "value": "COVID_19" }`
Offer	`offer`	`object`	Additional data for offer posts. This should only be set when the topicType is OFFER. See the documentation for more details.

Authentication#

Google Business Profile uses OAuth authentication. When you connect your Google Business Profile account, Pipedream will open a popup window where you can sign into Google Business Profile 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 Business Profile API.

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

https://www.googleapis.com/auth/business.manage