REST Resource: accounts.locations.localPosts

Resource: LocalPost

Represents a local post for a location.

JSON representation
{
  "name": string,
  "languageCode": string,
  "summary": string,
  "callToAction": {
    object(CallToAction)
  },
  "createTime": string,
  "updateTime": string,
  "event": {
    object(LocalPostEvent)
  },
  "state": enum(LocalPostState),
  "media": [
    {
      object(MediaItem)
    }
  ],
  "searchUrl": string,
  "topicType": enum(LocalPostTopicType),
  "offer": {
    object(LocalPostOffer)
  }
}
Fields
name

string

Output only. Google identifier for this local post in the form: accounts/{account_id}/locations/{location_id}/localPosts/{local_post_id}

languageCode

string

The language of the local post.

summary

string

Description/body of the local post.

callToAction

object(CallToAction)

The URL that users are sent to when clicking through the promotion. Ignored for topic type OFFER.

createTime

string (Timestamp format)

Output only. Time of the creation of the post.

A timestamp in RFC3339 UTC "Zulu" format, accurate to nanoseconds. Example: "2014-10-02T15:01:23.045123456Z".

updateTime

string (Timestamp format)

Output only. Time of the last modification of the post made by the user.

A timestamp in RFC3339 UTC "Zulu" format, accurate to nanoseconds. Example: "2014-10-02T15:01:23.045123456Z".

event

object(LocalPostEvent)

Event information. Required for topic types EVENT and OFFER.

state

enum(LocalPostState)

Output only. The state of the post, indicating what part of its lifecycle it is in.

media[]

object(MediaItem)

The media associated with the post.

searchUrl

string

Output only. The link to the local post in Google search. This link can be used to share the post via social media, email, text, etc.

topicType

enum(LocalPostTopicType)

Required. The topic type of the local posts: regular, event, offer.

offer

object(LocalPostOffer)

Extra fields of offer posts. It should only be set when post type is offer. Extra fields for new post types.

CallToAction

An action that is performed when the user clicks through the post

JSON representation
{
  "actionType": enum(ActionType),
  "url": string
}
Fields
actionType

enum(ActionType)

The type of action that will be performed.

url

string

The URL the user will be directed to upon clicking.

ActionType

The type of action that will be performed.

Enums
ACTION_TYPE_UNSPECIFIED Type unspecified.
BOOK This post wants a user to book an appointment/table/etc.
ORDER This post wants a user to order something.
SHOP This post wants a user to browse a product catalog.
LEARN_MORE This post wants a user to learn more (at their website).
SIGN_UP This post wants a user to register/sign up/join something.
GET_OFFER Deprecated. Use OFFER in LocalPostTopicType to create a post with offer content.

LocalPostEvent

All the information pertaining to an event featured in a local post.

JSON representation
{
  "title": string,
  "schedule": {
    object(TimeInterval)
  }
}
Fields
title

string

Name of the event.

schedule

object(TimeInterval)

Event start and end date/time.

TimeInterval

An interval of time, inclusive. It must contain all fields to be valid.

JSON representation
{
  "startDate": {
    object(Date)
  },
  "startTime": {
    object(TimeOfDay)
  },
  "endDate": {
    object(Date)
  },
  "endTime": {
    object(TimeOfDay)
  }
}
Fields
startDate

object(Date)

The start date of this period.

startTime

object(TimeOfDay)

The start time of this period.

endDate

object(Date)

The end date of this period.

endTime

object(TimeOfDay)

The end time of this period.

LocalPostState

Indicates what state the post is in

Enums
LOCAL_POST_STATE_UNSPECIFIED State not specified.
REJECTED This post was rejected due to content policy violation.
LIVE This post is published and is currently appearing in search results.

LocalPostTopicType

The topic type of the local post, which is used to select different templates to create and render a post.

Enums
LOCAL_POST_TOPIC_TYPE_UNSPECIFIED No post type is specified.
STANDARD Post contains basic information, like summary and images.
EVENT Post contains basic information and an event.
OFFER Post contains basic information, an event and offer related content (e.g. coupon code)

LocalPostOffer

Specific fields for offer posts.

JSON representation
{
  "couponCode": string,
  "redeemOnlineUrl": string,
  "termsConditions": string
}
Fields
couponCode

string

Optional. Offer code that is usable in store or online.

redeemOnlineUrl

string

Optional. Online link to redeem offer.

termsConditions

string

Optional. Offer terms and conditions.

Methods

create

Creates a new local post associated with the specified location, and returns it.

delete

Deletes a local post.

get

Gets the specified local post.

list

Returns a list of local posts associated with a location.

patch

Updates the specified local post and returns the updated local post.

reportInsights

Returns insights for a set of local posts associated with a single listing.

Send feedback about...

Google My Business API
Google My Business API
Need help? Visit our support page.