REST Resource: accounts.locations.localPosts

資源：LocalPost

代表地點的當地商家貼文。

JSON 表示法 
{
  "name": string,
  "languageCode": string,
  "summary": string,
  "callToAction": {
    object (CallToAction)
  },
  "createTime": string,
  "updateTime": string,
  "scheduledTime": string,
  "recurringInstanceTime": string,
  "event": {
    object (LocalPostEvent)
  },
  "state": enum (LocalPostState),
  "media": [
    {
      object (MediaItem)
    }
  ],
  "searchUrl": string,
  "topicType": enum (LocalPostTopicType),
  "alertType": enum (AlertType),

  // Union field topic_type_specific_fields can be only one of the following:
  "offer": {
    object (LocalPostOffer)
  }
  // End of list of possible types for union field topic_type_specific_fields.
}
欄位
name

string

僅供輸出。這個在地商家貼文的 Google ID，格式為：accounts/{accountId}/locations/{locationId}/localPosts/{local_post_id}
languageCode

string

當地貼文的語言。
summary

string

店面貼文的說明/內文。
callToAction

object (CallToAction)

使用者點按促銷活動後前往的網址。主題類型為「OFFER」時，系統會忽略這項設定。
createTime

string (Timestamp format)

僅供輸出。貼文的建立時間。

使用 RFC 3339，產生的輸出內容一律會經過 Z 正規化，並使用 0、3、6 或 9 個小數位數，也接受「Z」以外的偏移量。範例："2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z" 或 "2014-10-02T15:01:23+05:30"。
updateTime

string (Timestamp format)

僅供輸出。使用者上次修改貼文的時間。

使用 RFC 3339，產生的輸出內容一律會經過 Z 正規化，並使用 0、3、6 或 9 個小數位數，也接受「Z」以外的偏移量。範例："2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z" 或 "2014-10-02T15:01:23+05:30"。
scheduledTime

string (Timestamp format)

如果設定了發布時間，系統就會在該時間發布貼文。使用者可以設定這項資訊，預先安排貼文發布時間。

使用 RFC 3339，產生的輸出內容一律會經過 Z 正規化，並使用 0、3、6 或 9 個小數位數，也接受「Z」以外的偏移量。範例："2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z" 或 "2014-10-02T15:01:23+05:30"。
recurringInstanceTime
(deprecated)

string (Timestamp format)

僅供輸出。已淘汰：請改用 event.recurring_instance_time。這個欄位將在日後推出的版本中移除。僅供輸出。上次更新貼文週期性執行個體的時間。

使用 RFC 3339，產生的輸出內容一律會經過 Z 正規化，並使用 0、3、6 或 9 個小數位數，也接受「Z」以外的偏移量。範例："2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z" 或 "2014-10-02T15:01:23+05:30"。
event

object (LocalPostEvent)

活動資訊。主題類型為 EVENT 和 OFFER 時，必須提供這項資訊。
state

enum (LocalPostState)

僅供輸出。貼文的狀態，指出貼文目前處於生命週期的哪個階段。
media[]

object (MediaItem)

與貼文相關聯的媒體。LocalPost MediaItem 僅支援 sourceUrl 資料欄位。
searchUrl

string

僅供輸出。Google 搜尋中的當地商家貼文連結。你可以透過這個連結，在社群媒體、電子郵件、簡訊等管道分享貼文。
topicType

enum (LocalPostTopicType)

必填。貼文的主題類型：標準、活動、優惠或快訊。
alertType

enum (AlertType)

貼文建立的警報類型。這個欄位僅適用於 topicType 為「Alert」的貼文，且行為與「Alerts」的子類型相同。
聯集欄位 topic_type_specific_fields。主題類型的特定欄位。topic_type_specific_fields 只能是下列其中一項：
offer

object (LocalPostOffer)

優惠貼文的其他資料。只有在 topicType 為 OFFER 時，才應設定這項屬性。

CallToAction

使用者點選貼文後執行的動作

JSON 表示法 
{
  "actionType": enum (ActionType),
  "url": string
}
欄位
actionType

enum (ActionType)

要執行的動作類型。
url

string

使用者點按後會連上的網址。如果是通話號召性動作，請勿設定這個欄位。

ActionType

要執行的動作類型。

列舉
ACTION_TYPE_UNSPECIFIED 未指定類型。
BOOK 這則貼文希望使用者預約服務/座位等。
ORDER 這則貼文希望使用者訂購某項產品。
SHOP 這則貼文希望使用者瀏覽產品目錄。
LEARN_MORE 這則貼文希望使用者前往網站瞭解詳情。
SIGN_UP 這則貼文希望使用者註冊/登入/加入某項內容。
GET_OFFER

已淘汰，在 LocalPostTopicType 中使用 OFFER 建立含有優惠內容的貼文。
CALL 這則貼文希望使用者撥打商家電話。

LocalPostEvent

當地商家貼文中的活動相關資訊。

JSON 表示法 
{
  "title": string,
  "schedule": {
    object (TimeInterval)
  },
  "recurrenceInfo": {
    object (RecurrenceInfo)
  },
  "recurringInstanceTime": string
}
欄位
title

string

活動名稱。
schedule

object (TimeInterval)

活動開始和結束日期/時間。
recurrenceInfo

object (RecurrenceInfo)

(選用步驟) 儲存週期性貼文的頻率資訊。只有在貼文為週期性貼文時才會設定。
recurringInstanceTime

string (Timestamp format)

僅供輸出。上次更新貼文週期性執行個體的時間。

使用 RFC 3339，產生的輸出內容一律會經過 Z 正規化，並使用 0、3、6 或 9 個小數位數，也接受「Z」以外的偏移量。範例："2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z" 或 "2014-10-02T15:01:23+05:30"。

TimeInterval

時間間隔 (含)。必須包含所有欄位才有效。

JSON 表示法 
{
  "startDate": {
    object (Date)
  },
  "startTime": {
    object (TimeOfDay)
  },
  "endDate": {
    object (Date)
  },
  "endTime": {
    object (TimeOfDay)
  }
}
欄位
startDate

object (Date)

這個期間的開始日期。
startTime

object (TimeOfDay)

這個期間的開始時間。
endDate

object (Date)

這個期間的結束日期。
endTime

object (TimeOfDay)

這個期間的結束時間。

日期

表示完整或部分的日曆日期，例如生日。您可以視重要性決定是否要在別處指定時段和時區。日期以公曆為主，可代表下列其中一項：

  • 完整日期，具有非零的年、月和日值。
  • 月和日，年值為零 (例如週年紀念日)。
  • 只有年，月和日值為零。
  • 年和月，日值為零 (例如信用卡到期日)。

相關類型：

JSON 表示法 
{
  "year": integer,
  "month": integer,
  "day": integer
}
欄位
year

integer

日期年份。必須為 1 到 9999；如要指定不含年份的日期，請輸入 0。
month

integer

一年中的月份。必須為 1 到 12；如要指定不含日期的年份，請輸入 0。
day

integer

當月第幾日。必須為 1 到 31，並屬於有效的年和月；如果只指定年份，或只指定年份和月份，而不指定當月第幾日的話，請輸入 0。

TimeOfDay

代表一天中的時間。日期和時區並不需要指定，或是在其他位置上指定。API 可選擇允許閏秒。相關類型為 google.type.Date 和 google.protobuf.Timestamp。

JSON 表示法 
{
  "hours": integer,
  "minutes": integer,
  "seconds": integer,
  "nanos": integer
}
欄位
hours

integer

一天中的小時，採用 24 小時制。必須大於或等於 0，且通常必須小於或等於 23。API 可選擇允許使用「24:00:00」這類的值來表示營業打烊時間等情況。
minutes

integer

每小時的第幾分鐘。必須大於或等於 0，且小於或等於 59。
seconds

integer

一分鐘內的秒數。必須大於或等於 0，且通常必須小於或等於 59。如果 API 允許閏秒，則可允許值為 60。
nanos

integer

秒數的小數，以奈秒為單位。必須大於或等於 0，且小於或等於 999,999,999。

RecurrenceInfo

代表店面貼文的重複週期資訊。

JSON 表示法 
{
  "seriesEndTime": string,

  // Union field occurrence_pattern can be only one of the following:
  "dailyPattern": {
    object (DailyOccurrencePattern)
  },
  "weeklyPattern": {
    object (WeeklyOccurrencePattern)
  },
  "monthlyPattern": {
    object (MonthlyOccurrencePattern)
  }
  // End of list of possible types for union field occurrence_pattern.
}
欄位
seriesEndTime

string (Timestamp format)

(選用步驟) 重複系列的結束時間。

使用 RFC 3339，產生的輸出內容一律會經過 Z 正規化，並使用 0、3、6 或 9 個小數位數，也接受「Z」以外的偏移量。範例："2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z" 或 "2014-10-02T15:01:23+05:30"。
聯集欄位 occurrence_pattern。週期性貼文的發生模式。occurrence_pattern 只能是下列其中一項：
dailyPattern

object (DailyOccurrencePattern)

每日發生模式。
weeklyPattern

object (WeeklyOccurrencePattern)

每週發生次數模式。
monthlyPattern

object (MonthlyOccurrencePattern)

每月發生模式。

DailyOccurrencePattern

這個類型沒有任何欄位。

代表每日發生模式。

WeeklyOccurrencePattern

代表每週的發生模式。

JSON 表示法 
{
  "daysOfWeek": [
    enum (DayOfWeek)
  ]
}
欄位
daysOfWeek[]

enum (DayOfWeek)

(選用步驟) 優惠/活動的星期幾清單。如果為空白，貼文會在活動的 schedule.start_time 相同星期幾重複發布。

DayOfWeek

代表星期幾。

列舉
DAY_OF_WEEK_UNSPECIFIED 未指定星期。
MONDAY 星期一
TUESDAY 週二
WEDNESDAY 週三
THURSDAY 週四
FRIDAY Friday (週五)
SATURDAY Saturday (週六)
SUNDAY 星期日

MonthlyOccurrencePattern

代表每月發生一次的模式。

JSON 表示法 
{

  // Union field monthly_option can be only one of the following:
  "dayOfMonth": integer,
  "dayOfWeekOccurrence": enum (DayOfWeekOccurrence)
  // End of list of possible types for union field monthly_option.
}
欄位
聯集欄位 monthly_option。每月發生模式的週期性選項。monthly_option 只能是下列其中一項：
dayOfMonth

integer

當月第幾日。
dayOfWeekOccurrence

enum (DayOfWeekOccurrence)

該月內第幾次出現該星期幾。活動開始時間的星期幾會隱含活動的星期幾。舉例來說，如果活動在星期五開始，且 dayOfWeekOccurrence 為 SECOND，則活動會在每個月的第二個星期五重複。

DayOfWeekOccurrence

當月第幾週的星期幾。

列舉
DAY_OF_WEEK_OCCURRENCE_UNSPECIFIED 未指定星期幾。
FIRST 該月的第一個星期。
SECOND 當月第二個星期幾。
THIRD 當月的第三個星期幾。
FOURTH 當月的第四個星期幾。
LAST 當月最後一個星期日。

LocalPostState

指出貼文的狀態。

列舉
LOCAL_POST_STATE_UNSPECIFIED 未指定狀態。
REJECTED 這則貼文違反內容政策，因此遭到拒絕。
LIVE 這則貼文已發布，目前會顯示在搜尋結果中。
PROCESSING 這則貼文正在處理中，因此不會出現在搜尋結果中。
SCHEDULED 這則貼文已排定在未來發布，因此不會出現在搜尋結果中。
RECURRING 這篇貼文是週期性貼文，目前會顯示在搜尋結果中。

LocalPostTopicType

店面貼文的主題類型，用於選取不同範本來建立及顯示貼文。

列舉
LOCAL_POST_TOPIC_TYPE_UNSPECIFIED 未指定貼文類型。
STANDARD 貼文包含摘要和圖片等基本資訊。
EVENT 貼文包含基本資訊和活動。
OFFER 貼文內含基本資訊、活動和優惠相關內容 (例如優待券代碼)
ALERT 與進行中活動相關的即時重大公告。這類貼文不一定能建立。

AlertType

建立警報貼文的事件類型。

列舉
ALERT_TYPE_UNSPECIFIED 未指定任何快訊。
COVID_19 2019 年冠狀病毒疾病大流行相關快訊。新冠肺炎貼文僅支援摘要和行動號召欄位。如果這些快訊不再適用，系統就會停用 COVID-19 類型的新快訊貼文建立功能。不過，商家仍可管理現有的 COVID-19 貼文。

LocalPostOffer

優惠貼文的特定欄位。

JSON 表示法 
{
  "couponCode": string,
  "redeemOnlineUrl": string,
  "termsConditions": string
}
欄位
couponCode

string

(選用步驟) 可在店內或線上使用的優惠碼。
redeemOnlineUrl

string

(選用步驟) 線上優惠兌換連結。
termsConditions

string

(選用步驟) 優惠條款及細則。

方法

create

 建立與指定地點相關聯的新在地商家貼文，並傳回該貼文。

delete

 刪除在地商家貼文。

get

 取得指定的當地貼文。

list

 傳回與地點相關聯的當地貼文清單。

patch

 更新指定的店面貼文，並傳回更新後的店面貼文。