REST Resource: accounts.locations.localPosts

Recurso: LocalPost

Representa una publicación local para una ubicación.

Representación 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.
}
Campos
name

string

Solo salida. Identificador de Google para esta publicación local con el formato accounts/{accountId}/locations/{locationId}/localPosts/{local_post_id}
languageCode

string

Es el idioma de la publicación local.
summary

string

Es la descripción o el cuerpo de la publicación local.
callToAction

object (CallToAction)

Es la URL a la que se envía a los usuarios cuando hacen clic en la promoción. Se ignora para el tipo de tema OFFER.
createTime

string (Timestamp format)

Solo salida. Fecha y hora de creación de la publicación.

Usa el formato RFC 3339, en el que el resultado generado siempre usará la normalización Z y los dígitos fraccionarios 0, 3, 6 o 9. También se aceptan otras compensaciones que no sean “Z”. Ejemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" o "2014-10-02T15:01:23+05:30".
updateTime

string (Timestamp format)

Solo salida. Fecha y hora de la última modificación de la publicación realizada por el usuario.

Usa el formato RFC 3339, en el que el resultado generado siempre usará la normalización Z y los dígitos fraccionarios 0, 3, 6 o 9. También se aceptan otras compensaciones que no sean “Z”. Ejemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" o "2014-10-02T15:01:23+05:30".
scheduledTime

string (Timestamp format)

Si se configura, determina cuándo se publicará una publicación. El usuario puede establecer esta opción para programar publicaciones con anticipación.

Usa el formato RFC 3339, en el que el resultado generado siempre usará la normalización Z y los dígitos fraccionarios 0, 3, 6 o 9. También se aceptan otras compensaciones que no sean “Z”. Ejemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" o "2014-10-02T15:01:23+05:30".
recurringInstanceTime
(deprecated)

string (Timestamp format)

Solo salida. Obsoleto: Usa event.recurring_instance_time en su lugar. Este campo se quitará en una versión futura. Solo salida. Fecha y hora en la que se actualizó la instancia recurrente más reciente de la publicación.

Usa el formato RFC 3339, en el que el resultado generado siempre usará la normalización Z y los dígitos fraccionarios 0, 3, 6 o 9. También se aceptan otras compensaciones que no sean “Z”. Ejemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" o "2014-10-02T15:01:23+05:30".
event

object (LocalPostEvent)

Es la información del evento. Es obligatorio para los tipos de temas EVENT y OFFER.
state

enum (LocalPostState)

Solo salida. Es el estado de la publicación, que indica en qué parte de su ciclo de vida se encuentra.
media[]

object (MediaItem)

Es el contenido multimedia asociado a la publicación. sourceUrl es el único campo de datos admitido para un elemento MediaItem de LocalPost.
searchUrl

string

Solo salida. Es el vínculo a la publicación local en la Búsqueda de Google. Puedes usar este vínculo para compartir la publicación en redes sociales, por correo electrónico, mensaje de texto, etcétera.
topicType

enum (LocalPostTopicType)

Obligatorio. Es el tipo de tema de la publicación: estándar, evento, oferta o alerta.
alertType

enum (AlertType)

Es el tipo de alerta para la que se creó la publicación. Este campo solo se aplica a las publicaciones del tipo topicType Alert y se comporta como un subtipo de Alertas.
Campo de unión topic_type_specific_fields. Son los campos específicos de un tipo de tema. topic_type_specific_fields puede ser solo uno de los parámetros siguientes:
offer

object (LocalPostOffer)

Son datos adicionales para las publicaciones de ofertas. Solo se debe establecer cuando topicType es OFFER.

CallToAction

Es una acción que se realiza cuando el usuario hace clic en la publicación.

Representación JSON 
{
  "actionType": enum (ActionType),
  "url": string
}
Campos
actionType

enum (ActionType)

Es el tipo de acción que se realizará.
url

string

Es la URL a la que se dirigirá al usuario cuando haga clic. Este campo no debe configurarse para el CTA de llamada.

ActionType

Es el tipo de acción que se realizará.

Enums
ACTION_TYPE_UNSPECIFIED Indica un tipo no especificado.
BOOK Esta publicación quiere que un usuario reserve una cita, una mesa, etcétera.
ORDER En esta publicación, se le solicita al usuario que pida algo.
SHOP Esta publicación busca que el usuario explore un catálogo de productos.
LEARN_MORE Esta publicación busca que el usuario obtenga más información (en su sitio web).
SIGN_UP Esta publicación busca que un usuario se registre, se suscriba o se una a algo.
GET_OFFER

Obsoleta. Usa OFFER en LocalPostTopicType para crear una publicación con contenido de la oferta.
CALL Esta publicación quiere que un usuario llame a la empresa.

LocalPostEvent

Es toda la información relacionada con un evento que se destaca en una publicación local.

Representación JSON 
{
  "title": string,
  "schedule": {
    object (TimeInterval)
  },
  "recurrenceInfo": {
    object (RecurrenceInfo)
  },
  "recurringInstanceTime": string
}
Campos
title

string

Nombre del evento.
schedule

object (TimeInterval)

Fecha y hora de inicio y finalización del evento.
recurrenceInfo

object (RecurrenceInfo)

Opcional. Almacena información sobre la cadencia de una publicación recurrente. Solo se establecerá si la publicación es recurrente.
recurringInstanceTime

string (Timestamp format)

Solo salida. Fecha y hora en la que se actualizó la instancia recurrente más reciente de la publicación.

Usa el formato RFC 3339, en el que el resultado generado siempre usará la normalización Z y los dígitos fraccionarios 0, 3, 6 o 9. También se aceptan otras compensaciones que no sean “Z”. Ejemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" o "2014-10-02T15:01:23+05:30".

TimeInterval

Es un intervalo de tiempo, inclusive. Debe contener todos los campos para ser válido.

Representación JSON 
{
  "startDate": {
    object (Date)
  },
  "startTime": {
    object (TimeOfDay)
  },
  "endDate": {
    object (Date)
  },
  "endTime": {
    object (TimeOfDay)
  }
}
Campos
startDate

object (Date)

Es la fecha de inicio de este período.
startTime

object (TimeOfDay)

Es la hora de inicio de este período.
endDate

object (Date)

Es la fecha de finalización de este período.
endTime

object (TimeOfDay)

Es la hora de finalización de este período.

Fecha

Representa una fecha de calendario completa o parcial, como un cumpleaños. La hora del día y la zona horaria se especifican en otro lugar o son insignificantes. La fecha está relacionada con el calendario gregoriano. Puede representar una de las siguientes opciones:

  • Una fecha completa con valores para el año, mes y día que no sean cero.
  • Un mes y un día, con cero año (por ejemplo, un aniversario).
  • Un año por sí solo, con un mes cero y un día cero.
  • Es un año y un mes, con un día cero (por ejemplo, la fecha de vencimiento de una tarjeta de crédito).

Tipos relacionados:

Representación JSON 
{
  "year": integer,
  "month": integer,
  "day": integer
}
Campos
year

integer

Año de la fecha. Debe ser entre 1 y 9,999, o bien 0 para especificar una fecha sin año.
month

integer

Mes del año. Debe ser del 1 al 12 o 0 para especificar un año sin un mes ni un día.
day

integer

Día del mes. Debe ser entre 1 y 31 y ser válido para el año y el mes o bien 0 para especificar un año solo o un año y un mes en los que el día no sea significativo.

TimeOfDay

Representa una hora del día. La fecha y la zona horaria no son significativas o se especifican en otro lugar. Una API puede optar por permitir segundos bisiestos. Los tipos relacionados son google.type.Date y google.protobuf.Timestamp.

Representación JSON 
{
  "hours": integer,
  "minutes": integer,
  "seconds": integer,
  "nanos": integer
}
Campos
hours

integer

Horas de un día en formato de 24 horas. Debe ser mayor o igual que 0 y, por lo general, debe ser menor o igual que 23. Una API puede permitir el valor “24:00:00” para casos como el horario de cierre de empresas.
minutes

integer

Minutos de una hora. Debe ser mayor o igual que 0 y menor o igual que 59.
seconds

integer

Segundos de un minuto. Debe ser mayor o igual que 0 y, por lo general, debe ser menor o igual que 59. Una API puede permitir el valor 60 si permite segundos bisiestos.
nanos

integer

Fracciones de segundos, en nanosegundos. Debe ser mayor o igual que 0 y menor o igual que 999,999,999.

RecurrenceInfo

Representa la información de recurrencia de una publicación local.

Representación 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.
}
Campos
seriesEndTime

string (Timestamp format)

Opcional. Es la hora de finalización de la serie de recurrencias.

Usa el formato RFC 3339, en el que el resultado generado siempre usará la normalización Z y los dígitos fraccionarios 0, 3, 6 o 9. También se aceptan otras compensaciones que no sean “Z”. Ejemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" o "2014-10-02T15:01:23+05:30".
Campo de unión occurrence_pattern. Es el patrón de ocurrencia de la publicación recurrente. occurrence_pattern puede ser solo uno de los parámetros siguientes:
dailyPattern

object (DailyOccurrencePattern)

Patrón de ocurrencia diaria.
weeklyPattern

object (WeeklyOccurrencePattern)

Es el patrón de ocurrencia semanal.
monthlyPattern

object (MonthlyOccurrencePattern)

Patrón de ocurrencia mensual.

DailyOccurrencePattern

Este tipo no tiene campos.

Representa un patrón de ocurrencia diario.

WeeklyOccurrencePattern

Representa un patrón de ocurrencia semanal.

Representación JSON 
{
  "daysOfWeek": [
    enum (DayOfWeek)
  ]
}
Campos
daysOfWeek[]

enum (DayOfWeek)

Opcional. Es la lista de los días de la semana para la oferta o el evento. Si está vacío, la publicación se repetirá el mismo día de la semana que schedule.start_time del evento.

DayOfWeek

Representa un día de la semana.

Enumeraciones
DAY_OF_WEEK_UNSPECIFIED No se especifica el día de la semana.
MONDAY Lunes
TUESDAY Martes
WEDNESDAY Miércoles
THURSDAY Jueves
FRIDAY Viernes
SATURDAY Sábado
SUNDAY Domingo

MonthlyOccurrencePattern

Representa un patrón de ocurrencia mensual.

Representación 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.
}
Campos
Campo de unión monthly_option. Opción de recurrencia para el patrón de recurrencia mensual. monthly_option puede ser solo uno de los parámetros siguientes:
dayOfMonth

integer

Día del mes.
dayOfWeekOccurrence

enum (DayOfWeekOccurrence)

Es la ocurrencia del día de la semana en el mes. El día de la semana se infiere a partir del día de la semana de la hora de inicio del evento. Por ejemplo, si un evento comienza un viernes y dayOfWeekOccurrence es SECOND, el evento se repetirá el segundo viernes de cada mes.

DayOfWeekOccurrence

Es la ocurrencia del día de la semana en el mes.

Enums
DAY_OF_WEEK_OCCURRENCE_UNSPECIFIED Ocurrencia de día de la semana no especificado.
FIRST Primer día de la semana en el mes.
SECOND Segundo día de la semana en el mes.
THIRD Es el tercer día de la semana del mes.
FOURTH Cuarto día de la semana en el mes.
LAST Es el último día de la semana en el mes.

LocalPostState

Indica el estado de la publicación.

Enums
LOCAL_POST_STATE_UNSPECIFIED No se especificó el estado.
REJECTED Se rechazó esta publicación debido a un incumplimiento de la política de contenido.
LIVE Esta publicación está publicada y actualmente aparece en los resultados de la búsqueda.
PROCESSING Se está procesando esta publicación y no aparece en los resultados de la búsqueda.
SCHEDULED Esta publicación está programada para el futuro y no aparece en los resultados de la búsqueda.
RECURRING Esta publicación es recurrente y actualmente aparece en los resultados de la búsqueda.

LocalPostTopicType

Es el tipo de tema de la publicación local, que se usa para seleccionar diferentes plantillas para crear y renderizar una publicación.

Enums
LOCAL_POST_TOPIC_TYPE_UNSPECIFIED No se especificó ningún tipo de publicación.
STANDARD La publicación contiene información básica, como un resumen y las imágenes.
EVENT La publicación contiene información básica y un evento.
OFFER La publicación contiene información básica, un evento y contenido relacionado con la oferta (p. ej., un código de cupón).
ALERT Anuncios oportunos y de alta prioridad relacionados con un evento en curso. Estos tipos de publicaciones no siempre están disponibles para su creación.

AlertType

Es el tipo de evento para el que se creó la publicación de alerta.

Enums
ALERT_TYPE_UNSPECIFIED No se especificó ninguna alerta.
COVID_19 Alertas relacionadas con la pandemia de la enfermedad por coronavirus 2019. Las publicaciones sobre el COVID-19 solo admiten un campo de resumen y un campo de llamado a la acción. Cuando estas alertas ya no sean pertinentes, se inhabilitará la creación de publicaciones de alerta nuevas para el tipo COVID-19. Sin embargo, el comercio podrá seguir administrando sus publicaciones existentes sobre el COVID-19.

LocalPostOffer

Son los campos específicos para las publicaciones de ofertas.

Representación JSON 
{
  "couponCode": string,
  "redeemOnlineUrl": string,
  "termsConditions": string
}
Campos
couponCode

string

Opcional. Es el código de oferta que se puede usar en la tienda o en línea.
redeemOnlineUrl

string

Opcional. Vínculo en línea para canjear la oferta.
termsConditions

string

Opcional. Términos y condiciones de la oferta.

Métodos

create

 Crea una nueva publicación local asociada a la ubicación especificada y la devuelve.

delete

 Borra una publicación local.

get

 Obtiene la publicación local especificada.

list

 Devuelve una lista de publicaciones locales asociadas a una ubicación.

patch

 Actualiza la publicación local especificada y muestra la publicación local actualizada.