Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.postiz.com/llms.txt

Use this file to discover all available pages before exploring further.

​
Overview

Google My Business (GMB) allows you to create posts that appear on your Google Business Profile. You can create standard updates, events, or offers.

​
Settings Schema

{
  "__type": "gmb",
  "topicType": "STANDARD",
  "callToActionType": "LEARN_MORE",
  "callToActionUrl": "https://example.com",
  "eventTitle": "Event Name",
  "eventStartDate": "2024-12-14",
  "eventEndDate": "2024-12-15",
  "eventStartTime": "09:00",
  "eventEndTime": "17:00",
  "offerCouponCode": "SAVE20",
  "offerRedeemUrl": "https://example.com/redeem",
  "offerTerms": "Terms and conditions apply"
}

​
Properties

PropertyTypeRequiredDescription
__typestring✅Must be "gmb"
topicTypestring❌Post type: STANDARD, EVENT, or OFFER
callToActionTypestring❌CTA button type
callToActionUrlstring❌URL for CTA (required if callToActionType is set)
eventTitlestring❌Event name (required for EVENT type)
eventStartDatestring❌Event start date
eventEndDatestring❌Event end date
eventStartTimestring❌Event start time
eventEndTimestring❌Event end time
offerCouponCodestring❌Coupon code (for OFFER type)
offerRedeemUrlstring❌Redemption URL
offerTermsstring❌Offer terms and conditions

​
Call-to-Action Types

  • NONE - No button
  • BOOK - Book now
  • ORDER - Order online
  • SHOP - Shop now
  • LEARN_MORE - Learn more
  • SIGN_UP - Sign up
  • GET_OFFER - Get offer
  • CALL - Call

​
Examples

​
Standard Post

{
  "settings": {
    "__type": "gmb",
    "topicType": "STANDARD",
    "callToActionType": "LEARN_MORE",
    "callToActionUrl": "https://example.com/news"
  }
}

​
Event Post

{
  "settings": {
    "__type": "gmb",
    "topicType": "EVENT",
    "eventTitle": "Grand Opening",
    "eventStartDate": "2024-12-20",
    "eventEndDate": "2024-12-20",
    "eventStartTime": "10:00",
    "eventEndTime": "18:00",
    "callToActionType": "BOOK",
    "callToActionUrl": "https://example.com/rsvp"
  }
}

​
Offer Post

{
  "settings": {
    "__type": "gmb",
    "topicType": "OFFER",
    "callToActionType": "GET_OFFER",
    "callToActionUrl": "https://example.com/offer",
    "offerCouponCode": "HOLIDAY20",
    "offerRedeemUrl": "https://example.com/redeem",
    "offerTerms": "Valid until December 31, 2024. Cannot be combined with other offers."
  }
}

​
Full Example

{
  "type": "schedule",
  "date": "2024-12-14T10:00:00.000Z",
  "shortLink": false,
  "tags": [],
  "posts": [
    {
      "integration": {
        "id": "your-gmb-integration-id"
      },
      "value": [
        {
          "content": "🎉 Big Holiday Sale! Get 20% off all products this weekend only. Visit us in-store or shop online!",
          "image": [
            {
              "id": "img-id",
              "path": "https://uploads.postiz.com/sale-banner.jpg"
            }
          ]
        }
      ],
      "settings": {
        "__type": "gmb",
        "topicType": "OFFER",
        "callToActionType": "GET_OFFER",
        "callToActionUrl": "https://example.com/holiday-sale",
        "offerCouponCode": "HOLIDAY20",
        "offerTerms": "Valid December 14-15, 2024. In-store and online."
      }
    }
  ]
}

​
Notes

  • GMB posts appear on your Google Business Profile in Search and Maps
  • Images are highly recommended for better engagement
  • Event posts require date/time information
  • Offer posts can include coupon codes for tracking