REST Resource: accounts.locations.localPosts

منبع: لوکال‌پست

نشان دهنده یک پست محلی برای یک مکان است.

نمایش 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

فقط خروجی. شناسه گوگل برای این پست محلی به شکل: accounts/{accountId}/locations/{locationId}/localPosts/{local_post_id}

languageCode

string

زبان پست محلی.

summary

string

توضیحات/متن پست محلی.

callToAction

object ( CallToAction )

URL ای که کاربران هنگام کلیک روی تبلیغات به آن هدایت می‌شوند. برای نوع موضوع OFFER نادیده گرفته می‌شود.

createTime

string ( Timestamp format)

فقط خروجی. زمان ایجاد پست.

از RFC 3339 استفاده می‌کند، که در آن خروجی تولید شده همیشه به صورت Z-normalized خواهد بود و از ارقام کسری ۰، ۳، ۶ یا ۹ استفاده می‌کند. آفست‌های غیر از "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-normalized خواهد بود و از ارقام کسری ۰، ۳، ۶ یا ۹ استفاده می‌کند. آفست‌های غیر از "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-normalized خواهد بود و از ارقام کسری ۰، ۳، ۶ یا ۹ استفاده می‌کند. آفست‌های غیر از "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-normalized خواهد بود و از ارقام کسری ۰، ۳، ۶ یا ۹ استفاده می‌کند. آفست‌های غیر از "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 )

رسانه مرتبط با post.sourceUrl تنها فیلد داده پشتیبانی شده برای LocalPost MediaItem است.

searchUrl

string

فقط خروجی. لینک به پست محلی در جستجوی گوگل. از این لینک می‌توان برای اشتراک‌گذاری پست از طریق رسانه‌های اجتماعی، ایمیل، پیامک و غیره استفاده کرد.

topicType

enum ( LocalPostTopicType )

الزامی. نوع موضوع پست: استاندارد، رویداد، پیشنهاد یا هشدار.

alertType

enum ( AlertType )

نوع هشداری که پست برای آن ایجاد شده است. این فیلد فقط برای پست‌هایی با موضوع هشدار (topicType Alert) قابل استفاده است و به عنوان زیرمجموعه‌ای از هشدارها عمل می‌کند.

فیلد اتحادیه topic_type_specific_fields . فیلدهای خاص برای یک نوع موضوع. topic_type_specific_fields فقط می‌تواند یکی از موارد زیر باشد:
offer

object ( LocalPostOffer )

داده‌های اضافی برای پست‌های پیشنهاد. این مورد فقط باید زمانی تنظیم شود که موضوع (topicType) روی پیشنهاد (OFFER) باشد.

فراخوان عمل

عملی که هنگام کلیک کاربر روی پست انجام می‌شود

نمایش JSON 
{
  "actionType": enum (ActionType),
  "url": string
}
فیلدها
actionType

enum ( ActionType )

نوع عملی که انجام خواهد شد.

url

string

URL ای که کاربر پس از کلیک به آن هدایت می‌شود. این فیلد باید برای فراخوان اقدام به تماس (CTA) تنظیم نشده باقی بماند.

نوع اقدام

نوع عملی که انجام خواهد شد.

انوم‌ها
ACTION_TYPE_UNSPECIFIED نوع نامشخص.
BOOK این پست می‌خواهد یک کاربر قرار ملاقات/میز/و غیره رزرو کند.
ORDER این پست می‌خواهد یک کاربر چیزی سفارش دهد.
SHOP این پست می‌خواهد کاربر کاتالوگ محصولات را مرور کند.
LEARN_MORE این پست می‌خواهد کاربر (در وب‌سایتشان) اطلاعات بیشتری کسب کند.
SIGN_UP این پست می‌خواهد یک کاربر ثبت‌نام/ثبت‌نام/عضویت در چیزی را انجام دهد.
GET_OFFER

منسوخ شده. OFFER در LocalPostTopicType برای ایجاد پستی با محتوای پیشنهاد استفاده کنید.

CALL این پست می‌خواهد که یک کاربر با آن کسب و کار تماس بگیرد.

رویداد پست محلی

تمام اطلاعات مربوط به یک رویداد که در یک پست محلی نمایش داده شده است.

نمایش 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-normalized خواهد بود و از ارقام کسری ۰، ۳، ۶ یا ۹ استفاده می‌کند. آفست‌های غیر از "Z" نیز پذیرفته می‌شوند. مثال‌ها: "2014-10-02T15:01:23Z" ، "2014-10-02T15:01:23.045123456Z" یا "2014-10-02T15:01:23+05:30" .

بازه زمانی

یک بازه زمانی، شامل همه فیلدها. برای معتبر بودن باید شامل همه فیلدها باشد.

نمایش 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

سال تاریخ. باید از ۱ تا ۹۹۹۹ باشد، یا برای مشخص کردن تاریخ بدون سال، ۰ باشد.

month

integer

ماه سال. باید از ۱ تا ۱۲ باشد، یا برای مشخص کردن سال بدون ماه و روز، ۰ باشد.

day

integer

روز ماه. باید از ۱ تا ۳۱ باشد و برای سال و ماه معتبر باشد، یا ۰ برای مشخص کردن یک سال به تنهایی یا یک سال و ماه که روز در آن مهم نیست.

زمان روز

نشان دهنده یک زمان از روز است. تاریخ و منطقه زمانی یا مهم نیستند یا در جای دیگری مشخص شده‌اند. یک API ممکن است ثانیه کبیسه را مجاز بداند. انواع مرتبط عبارتند از google.type.Date و google.protobuf.Timestamp .

نمایش JSON 
{
  "hours": integer,
  "minutes": integer,
  "seconds": integer,
  "nanos": integer
}
فیلدها
hours

integer

ساعات یک روز در قالب ۲۴ ساعته. باید بزرگتر یا مساوی ۰ و معمولاً کوچکتر یا مساوی ۲۳ باشد. یک API ممکن است برای سناریوهایی مانند زمان تعطیلی کسب و کار، مقدار "۲۴:۰۰:۰۰" را مجاز بداند.

minutes

integer

دقیقه‌های یک ساعت. باید بزرگتر یا مساوی ۰ و کوچکتر یا مساوی ۵۹ باشد.

seconds

integer

ثانیه‌های یک دقیقه. باید بزرگتر یا مساوی ۰ و معمولاً کوچکتر یا مساوی ۵۹ باشد. یک API در صورت امکان ثانیه کبیسه، ممکن است مقدار ۶۰ را نیز مجاز بداند.

nanos

integer

کسری از ثانیه، بر حسب نانوثانیه. باید بزرگتر یا مساوی ۰ و کوچکتر یا مساوی ۹۹۹,۹۹۹,۹۹۹ باشد.

اطلاعات تکرار

اطلاعات تکرار برای یک پست محلی را نشان می‌دهد.

نمایش 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-normalized خواهد بود و از ارقام کسری ۰، ۳، ۶ یا ۹ استفاده می‌کند. آفست‌های غیر از "Z" نیز پذیرفته می‌شوند. مثال‌ها: "2014-10-02T15:01:23Z" ، "2014-10-02T15:01:23.045123456Z" یا "2014-10-02T15:01:23+05:30" .

فیلد union occurrence_pattern . الگوی وقوع برای پست‌های تکراری. occurrence_pattern می‌تواند فقط یکی از موارد زیر باشد:
dailyPattern

object ( DailyOccurrencePattern )

الگوی وقوع روزانه.

weeklyPattern

object ( WeeklyOccurrencePattern )

الگوی وقوع هفتگی.

monthlyPattern

object ( MonthlyOccurrencePattern )

الگوی وقوع ماهانه.

الگوی رخداد روزانه

این نوع هیچ فیلدی ندارد.

نشان دهنده یک الگوی رخداد روزانه است.

الگوی وقوع هفتگی

نشان دهنده یک الگوی وقوع هفتگی است.

نمایش JSON 
{
  "daysOfWeek": [
    enum (DayOfWeek)
  ]
}
فیلدها
daysOfWeek[]

enum ( DayOfWeek )

اختیاری. فهرست روزهای هفته برای پیشنهاد/رویداد. اگر خالی باشد، پست در همان روز هفته با schedule.start_time رویداد تکرار می‌شود.

روز هفته

نشان دهنده یک روز از هفته است.

انوم‌ها
DAY_OF_WEEK_UNSPECIFIED روز هفته مشخص نشده است.
MONDAY دوشنبه
TUESDAY سه‌شنبه
WEDNESDAY چهارشنبه
THURSDAY پنجشنبه
FRIDAY جمعه
SATURDAY شنبه
SUNDAY یکشنبه

الگوی وقوع ماهانه

نشان دهنده الگوی وقوع ماهانه است.

نمایش 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 باشد، رویداد در دومین جمعه هر ماه تکرار خواهد شد.

روز هفته

وقوع روز هفته در ماه.

انوم‌ها
DAY_OF_WEEK_OCCURRENCE_UNSPECIFIED وقوع در روز نامشخصی از هفته.
FIRST اولین روز هفته در ماه.
SECOND دومین روز هفته در ماه.
THIRD سومین روز هفته در ماه.
FOURTH چهارمین روز هفته در ماه.
LAST آخرین روز هفته در ماه.

وضعیت پست محلی

نشان می‌دهد که پست در چه وضعیتی است.

انوم‌ها
LOCAL_POST_STATE_UNSPECIFIED ایالت مشخص نشده است.
REJECTED این پست به دلیل نقض سیاست محتوا رد شد.
LIVE این پست منتشر شده و در حال حاضر در نتایج جستجو نمایش داده می‌شود.
PROCESSING این پست در حال پردازش است و در نتایج جستجو نمایش داده نمی‌شود.
SCHEDULED این پست برای آینده برنامه‌ریزی شده است و در نتایج جستجو نمایش داده نمی‌شود.
RECURRING این پست یک پست تکراری است و در حال حاضر در نتایج جستجو نمایش داده می‌شود.

نوع پست محلی

نوع موضوع پست محلی، که برای انتخاب قالب‌های مختلف برای ایجاد و نمایش یک پست استفاده می‌شود.

انوم‌ها
LOCAL_POST_TOPIC_TYPE_UNSPECIFIED نوع پست مشخص نشده است.
STANDARD پست شامل اطلاعات اولیه، مانند خلاصه و تصاویر است.
EVENT پست شامل اطلاعات اولیه و یک رویداد است.
OFFER پست شامل اطلاعات اولیه، یک رویداد و محتوای مرتبط با پیشنهاد (مثلاً کد تخفیف) است
ALERT اطلاعیه‌های با اولویت بالا و به موقع مربوط به یک رویداد جاری. این نوع پست‌ها همیشه برای نوشتن در دسترس نیستند.

نوع هشدار

نوع رویدادی که پست هشدار برای آن ایجاد شده است.

انوم‌ها
ALERT_TYPE_UNSPECIFIED هیچ هشداری مشخص نشده است.
COVID_19 هشدارهای مربوط به همه‌گیری بیماری کرونا ۲۰۱۹. پست‌های کووید فقط از یک فیلد خلاصه و یک فیلد فراخوان برای اقدام پشتیبانی می‌کنند. وقتی این هشدارها دیگر مرتبط نباشند، ایجاد پست هشدار جدید برای نوع کووید-۱۹ غیرفعال خواهد شد. با این حال، فروشنده همچنان می‌تواند پست‌های کووید-۱۹ موجود خود را مدیریت کند.

پیشنهاد پست محلی

فیلدهای خاص برای پست‌های پیشنهاد.

نمایش JSON 
{
  "couponCode": string,
  "redeemOnlineUrl": string,
  "termsConditions": string
}
فیلدها
couponCode

string

اختیاری. کد تخفیفی که در فروشگاه یا آنلاین قابل استفاده است.

redeemOnlineUrl

string

اختیاری. لینک آنلاین برای استفاده از پیشنهاد.

termsConditions

string

اختیاری. شرایط و ضوابط ارائه دهید.

روش‌ها

create

 یک پست محلی جدید مرتبط با مکان مشخص شده ایجاد می‌کند و آن را برمی‌گرداند.

delete

 یک پست محلی را حذف می‌کند.

get

 پست محلی مشخص شده را دریافت می‌کند.

list

 لیستی از پست‌های محلی مرتبط با یک مکان را برمی‌گرداند.

patch

 پست محلی مشخص شده را به‌روزرسانی می‌کند و پست محلی به‌روزرسانی شده را برمی‌گرداند.