Saltar al contenido principal

​
Submódulos

​
Contenido del módulo

Este módulo proporciona acceso a los endpoints de publicaciones de X API y sirve como punto de entrada principal para toda la funcionalidad relacionada con publicaciones.

​
class xdk.posts.PostsClient

Cliente para operaciones con Publicaciones

​
Parámetros

​
path.client
Client

​
__init__

​
Parámetros

​
path.client
Client

​
create

Crear o editar una Publicación Crea una nueva Publicación para el usuario autenticado o edita una Publicación existente cuando se proporcionan edit_options. body: Cuerpo de la solicitud :returns: Datos de la respuesta :rtype: CreateResponse

​
Parámetros

​
body.body
CreateRequest

​
delete

Eliminar una Publicación Elimina una Publicación específica por su id, siempre que sea propiedad del usuario autenticado.

​
Parámetros

​
path.id
Any
El identificador de la Publicación que se va a eliminar.

​
Devuelve

DeleteResponse - Datos de respuesta

​
get_analytics

Obtener analíticas de Publicaciones Obtiene datos analíticos de Publicaciones específicas dentro de un intervalo de tiempo definido.

​
Parámetros

​
path.ids
List
Una lista de id de publicaciones separadas por comas. Se permiten hasta 100 en una sola solicitud.
​
path.end_time
str
YYYY-MM-DDTHH:mm:ssZ. La marca de tiempo UTC que representa el final del intervalo de tiempo.
​
path.start_time
str
YYYY-MM-DDTHH:mm:ssZ. La marca de tiempo UTC que representa el inicio del intervalo de tiempo.
​
path.granularity
str
La granularidad para los resultados del conteo de búsqueda.
​
path.analytics_fields
List or None
predeterminado:"None"
Una lista de campos de Analytics separados por comas que se mostrarán.

​
Devuelve

GetAnalyticsResponse - Datos de respuesta

​
get_by_id

Obtener una Publicación por ID Obtiene los detalles de una Publicación específica por su ID.

​
Parámetros

​
path.id
Any
Un único identificador de Publicación.
​
path.tweet_fields
List or None
predeterminado:"None"
Una lista separada por comas de campos de Tweet para mostrar.
​
path.expansions
List or None
predeterminado:"None"
Una lista separada por comas de campos para expandir.
​
path.media_fields
List or None
predeterminado:"None"
Una lista separada por comas de campos de Media para mostrar.
​
path.poll_fields
List or None
predeterminado:"None"
Una lista separada por comas de campos de Poll para mostrar.
​
path.user_fields
List or None
predeterminado:"None"
Una lista separada por comas de campos de User para mostrar.
​
path.place_fields
List or None
predeterminado:"None"
Una lista separada por comas de campos de Place para mostrar.

​
Devuelve

GetByIdResponse - Datos de respuesta

​
get_by_ids

Obtén Publicaciones por id Recupera los detalles de varias publicaciones por sus id.

​
Parámetros

​
path.ids
List
Una lista separada por comas de ID de publicaciones. Se permiten hasta 100 en una sola solicitud.
​
path.tweet_fields
List or None
predeterminado:"None"
Una lista separada por comas de campos de Tweet para mostrar.
​
path.expansions
List or None
predeterminado:"None"
Una lista separada por comas de campos que se deben expandir.
​
path.media_fields
List or None
predeterminado:"None"
Una lista separada por comas de campos de medios para mostrar.
​
path.poll_fields
List or None
predeterminado:"None"
Una lista separada por comas de campos de encuestas para mostrar.
​
path.user_fields
List or None
predeterminado:"None"
Una lista separada por comas de campos de usuario para mostrar.
​
path.place_fields
List or None
predeterminado:"None"
Una lista separada por comas de campos de lugares para mostrar.

​
Devuelve

GetByIdsResponse - Datos de respuesta

​
get_counts_all

Obtener el recuento total de todas las Publicaciones Obtiene el recuento de Publicaciones que coinciden con una consulta de búsqueda en todo el archivo.

​
Parámetros

​
path.query
str
Una consulta/regla/filtro para hacer coincidir Publicaciones. Consulta https://t.co/rulelength para identificar la longitud máxima de la consulta.
​
path.start_time
str or None
predeterminado:"None"
YYYY-MM-DDTHH:mm:ssZ. La marca de tiempo UTC más antigua (de los últimos 7 días) a partir de la cual se proporcionarán las Publicaciones. La marca de tiempo tiene granularidad de segundos y es inclusiva (es decir, 12:00:01 incluye el primer segundo del minuto).
​
path.end_time
str or None
predeterminado:"None"
YYYY-MM-DDTHH:mm:ssZ. La marca de tiempo UTC más reciente hasta la cual se proporcionarán las Publicaciones. La marca de tiempo tiene granularidad de segundos y es exclusiva (es decir, 12:00:01 excluye el primer segundo del minuto).
​
path.since_id
Any or None
predeterminado:"None"
Devuelve resultados con un ID de Publicación mayor (es decir, más reciente) que el ID especificado.
​
path.until_id
Any or None
predeterminado:"None"
Devuelve resultados con un ID de Publicación menor (es decir, más antiguo) que el ID especificado.
​
path.next_token
Any or None
predeterminado:"None"
Este parámetro se usa para obtener la siguiente “página” de resultados. El valor utilizado con el parámetro se extrae directamente de la respuesta proporcionada por la API y no debe modificarse.
​
path.pagination_token
Any or None
predeterminado:"None"
Este parámetro se usa para obtener la siguiente “página” de resultados. El valor utilizado con el parámetro se extrae directamente de la respuesta proporcionada por la API y no debe modificarse.
​
path.granularity
str or None
predeterminado:"None"
La granularidad de los resultados de recuento de búsqueda.
​
path.search_count_fields
List or None
predeterminado:"None"
Una lista de campos SearchCount, separados por comas, que se mostrarán.

​
Devuelve

IteratorGetCountsAllResponse

​
get_counts_recent

Obtener el número de Publicaciones recientes Recupera el número de Publicaciones de los últimos 7 días que coinciden con una consulta de búsqueda.

​
Parámetros

​
path.query
str
Una consulta/regla/filtro para encontrar Publicaciones que coincidan. Consulta https://t.co/rulelength para identificar la longitud máxima de la consulta.
​
path.start_time
str or None
predeterminado:"None"
YYYY-MM-DDTHH:mm:ssZ. La marca de tiempo UTC más antigua (de los 7 días más recientes) a partir de la cual se proporcionarán las Publicaciones. La marca de tiempo tiene granularidad de segundos y es inclusiva (es decir, 12:00:01 incluye el primer segundo del minuto).
​
path.end_time
str or None
predeterminado:"None"
YYYY-MM-DDTHH:mm:ssZ. La marca de tiempo UTC más reciente hasta la cual se proporcionarán las Publicaciones. La marca de tiempo tiene granularidad de segundos y es exclusiva (es decir, 12:00:01 excluye el primer segundo del minuto).
​
path.since_id
Any or None
predeterminado:"None"
Devuelve resultados con un ID de Publicación mayor (es decir, más reciente) que el ID especificado.
​
path.until_id
Any or None
predeterminado:"None"
Devuelve resultados con un ID de Publicación menor (es decir, más antiguo) que el ID especificado.
​
path.next_token
Any or None
predeterminado:"None"
Este parámetro se usa para obtener la siguiente “página” de resultados. El valor usado con el parámetro se extrae directamente de la respuesta proporcionada por la API y no debe modificarse.
​
path.pagination_token
Any or None
predeterminado:"None"
Este parámetro se usa para obtener la siguiente “página” de resultados. El valor usado con el parámetro se extrae directamente de la respuesta proporcionada por la API y no debe modificarse.
​
path.granularity
str or None
predeterminado:"None"
La granularidad de los resultados de recuentos de búsqueda.
​
path.search_count_fields
List or None
predeterminado:"None"
Una lista de campos SearchCount, separados por comas, que se mostrarán.

​
Devuelve

IteratorGetCountsRecentResponse

​
get_insights28hr

Obtiene estadísticas de Publicaciones de las últimas 28 horas Recupera métricas de interacción para las Publicaciones especificadas durante las últimas 28 horas.

​
Parámetros

​
path.tweet_ids
List
Lista de PostIds para métricas de 28 horas.
​
path.granularity
str
Granularidad de la respuesta de métricas.
​
path.requested_metrics
List
Métricas solicitadas para una consulta histórica.
​
path.engagement_fields
List or None
predeterminado:"None"
Una lista separada por comas de campos de Engagement para mostrar.

​
Devuelve

GetInsights28hrResponse - Datos de respuesta

​
get_insights_historical

Obtener estadísticas históricas de Publicaciones Recupera métricas históricas de interacción para Publicaciones especificadas dentro de un intervalo de tiempo definido.

​
Parámetros

​
path.tweet_ids
List
Lista de id de Publicación para métricas históricas.
​
path.end_time
str
YYYY-MM-DDTHH:mm:ssZ. La marca de tiempo en UTC que representa el final del intervalo de tiempo.
​
path.start_time
str
YYYY-MM-DDTHH:mm:ssZ. La marca de tiempo en UTC que representa el inicio del intervalo de tiempo.
​
path.granularity
str
Granularidad de la respuesta de métricas.
​
path.requested_metrics
List
Métricas solicitadas para la consulta histórica.
​
path.engagement_fields
List or None
predeterminado:"None"
Una lista separada por comas de campos de engagement que se mostrarán.

​
Devuelve

GetInsightsHistoricalResponse - Datos de la respuesta

​
get_liking_users

Obtener usuarios a los que les gusta Recupera una lista de usuarios a los que les gustó una Publicación específica por su id.

​
Parámetros

​
path.id
Any
Un único ID de Publicación.
​
path.max_results
int or None
predeterminado:"None"
El número máximo de resultados.
​
path.pagination_token
Any or None
predeterminado:"None"
Este parámetro se utiliza para obtener la siguiente página de resultados.
​
path.user_fields
List or None
predeterminado:"None"
Una lista de campos de usuario, separados por comas, para mostrar.
​
path.expansions
List or None
predeterminado:"None"
Una lista de campos, separados por comas, para expandir.
​
path.tweet_fields
List or None
predeterminado:"None"
Una lista de campos de Tweet, separados por comas, para mostrar.

​
Devuelve

IteratorGetLikingUsersResponse

​
get_quoted

Obtener publicaciones citadas Obtiene una lista de Publicaciones que citan una Publicación específica por su ID.

​
Parámetros

​
path.id
Any
Un único ID de la Publicación.
​
path.max_results
int or None
predeterminado:"None"
El número máximo de resultados que se devolverán.
​
path.pagination_token
Any or None
predeterminado:"None"
Este parámetro se utiliza para obtener una «página» específica de resultados.
​
path.exclude
List or None
predeterminado:"None"
El conjunto de entidades que se deben excluir (p. ej., «respuestas» o «retweets»).
​
path.tweet_fields
List or None
predeterminado:"None"
Una lista separada por comas de campos de Tweet que se mostrarán.
​
path.expansions
List or None
predeterminado:"None"
Una lista separada por comas de campos que se expandirán.
​
path.media_fields
List or None
predeterminado:"None"
Una lista separada por comas de campos de medios que se mostrarán.
​
path.poll_fields
List or None
predeterminado:"None"
Una lista separada por comas de campos de encuestas que se mostrarán.
​
path.user_fields
List or None
predeterminado:"None"
Una lista separada por comas de campos de usuario que se mostrarán.
​
path.place_fields
List or None
predeterminado:"None"
Una lista separada por comas de campos de lugares que se mostrarán.

​
Devuelve

IteratorGetQuotedResponse

​
get_reposted_by

Obtener “Reposted by” Recupera una lista de usuarios que hicieron repost de una Publicación específica por su id.

​
Parámetros

​
path.id
Any
Un único ID de Publicación.
​
path.max_results
int or None
predeterminado:"None"
El número máximo de resultados.
​
path.pagination_token
Any or None
predeterminado:"None"
Este parámetro se usa para obtener la siguiente «página» de resultados.
​
path.user_fields
List or None
predeterminado:"None"
Una lista separada por comas de campos de usuario que se van a mostrar.
​
path.expansions
List or None
predeterminado:"None"
Una lista separada por comas de campos que se van a expandir.
​
path.tweet_fields
List or None
predeterminado:"None"
Una lista separada por comas de campos de Tweet que se van a mostrar.

​
Devuelve

IteratorGetRepostedByResponse

​
get_reposts

Obtener Reposts Obtiene una lista de Publicaciones que hacen repost de una Publicación específica por su id.

​
Parámetros

​
path.id
Any
Un único id de Publicación.
​
path.max_results
int or None
predeterminado:"None"
El número máximo de resultados.
​
path.pagination_token
Any or None
predeterminado:"None"
Este parámetro se utiliza para obtener la siguiente ‘página’ de resultados.
​
path.tweet_fields
List or None
predeterminado:"None"
Una lista separada por comas de campos de Tweet para mostrar.
​
path.expansions
List or None
predeterminado:"None"
Una lista separada por comas de campos que se expandirán.
​
path.media_fields
List or None
predeterminado:"None"
Una lista separada por comas de campos de medios para mostrar.
​
path.poll_fields
List or None
predeterminado:"None"
Una lista separada por comas de campos de encuesta para mostrar.
​
path.user_fields
List or None
predeterminado:"None"
Una lista separada por comas de campos de usuario para mostrar.
​
path.place_fields
List or None
predeterminado:"None"
Una lista separada por comas de campos de lugar para mostrar.

​
Devuelve

IteratorGetRepostsResponse

​
hide_reply

Ocultar respuesta Oculta o deja de ocultar una respuesta en una conversación que pertenece al usuario autenticado.

​
Parámetros

​
path.tweet_id
Any
El identificador de la respuesta que deseas ocultar o dejar de ocultar.
​
body.body
HideReplyRequest
Cuerpo de la solicitud

​
search_all

Buscar todas las Publicaciones Obtiene Publicaciones del archivo completo que coinciden con una consulta de búsqueda.

​
Parámetros

​
path.query
str
Una consulta/regla/filtro para filtrar Publicaciones. Consulta https://t.co/rulelength para identificar la longitud máxima de la consulta.
​
path.start_time
str or None
predeterminado:"None"
YYYY-MM-DDTHH:mm:ssZ. La marca de tiempo UTC más antigua desde la cual se proporcionarán las Publicaciones. La marca de tiempo tiene granularidad de segundos y es inclusiva (es decir, 12:00:01 incluye el primer segundo del minuto).
​
path.end_time
str or None
predeterminado:"None"
YYYY-MM-DDTHH:mm:ssZ. La marca de tiempo UTC más reciente hasta la cual se proporcionarán las Publicaciones. La marca de tiempo tiene granularidad de segundos y es exclusiva (es decir, 12:00:01 excluye el primer segundo del minuto).
​
path.since_id
Any or None
predeterminado:"None"
Devuelve resultados con un ID de Publicación mayor (es decir, más reciente) que el ID especificado.
​
path.until_id
Any or None
predeterminado:"None"
Devuelve resultados con un ID de Publicación menor (es decir, más antigua) que el ID especificado.
​
path.max_results
int or None
predeterminado:"None"
El número máximo de resultados de búsqueda que se devolverán en una solicitud.
​
path.next_token
Any or None
predeterminado:"None"
Este parámetro se usa para obtener la siguiente «página» de resultados. El valor usado con el parámetro se extrae directamente de la respuesta proporcionada por la API y no debe modificarse.
​
path.pagination_token
Any or None
predeterminado:"None"
Este parámetro se usa para obtener la siguiente «página» de resultados. El valor usado con el parámetro se extrae directamente de la respuesta proporcionada por la API y no debe modificarse.
​
path.sort_order
str or None
predeterminado:"None"
El orden en el que se devolverán los resultados.
​
path.tweet_fields
List or None
predeterminado:"None"
Una lista separada por comas de campos de Tweet para mostrar.
​
path.expansions
List or None
predeterminado:"None"
Una lista separada por comas de campos para expandir.
​
path.media_fields
List or None
predeterminado:"None"
Una lista separada por comas de campos de medios para mostrar.
​
path.poll_fields
List or None
predeterminado:"None"
Una lista separada por comas de campos de encuestas para mostrar.
​
path.user_fields
List or None
predeterminado:"None"
Una lista separada por comas de campos de usuario para mostrar.
​
path.place_fields
List or None
predeterminado:"None"
Una lista separada por comas de campos de lugar para mostrar.

​
Devuelve

IteratorSearchAllResponse

​
search_recent

Busca Publicaciones recientes Obtiene Publicaciones de los últimos 7 días que coinciden con una consulta de búsqueda.

​
Parámetros

​
path.query
str
Una consulta/regla/filtro para hacer coincidir publicaciones. Consulta https://t.co/rulelength para conocer la longitud máxima de la consulta.
​
path.start_time
str or None
predeterminado:"None"
YYYY-MM-DDTHH:mm:ssZ. La marca de tiempo UTC más antigua desde la que se proporcionarán las publicaciones. La marca de tiempo tiene granularidad de segundos y es inclusiva (es decir, 12:00:01 incluye el primer segundo del minuto).
​
path.end_time
str or None
predeterminado:"None"
YYYY-MM-DDTHH:mm:ssZ. La marca de tiempo UTC más reciente hasta la que se proporcionarán las publicaciones. La marca de tiempo tiene granularidad de segundos y es exclusiva (es decir, 12:00:01 excluye el primer segundo del minuto).
​
path.since_id
Any or None
predeterminado:"None"
Devuelve resultados con un ID de publicación mayor que (es decir, más reciente que) el ID especificado.
​
path.until_id
Any or None
predeterminado:"None"
Devuelve resultados con un ID de publicación menor que (es decir, más antiguo que) el ID especificado.
​
path.max_results
int or None
predeterminado:"None"
El número máximo de resultados de búsqueda que se devolverán en una solicitud.
​
path.next_token
Any or None
predeterminado:"None"
Este parámetro se usa para obtener la siguiente «página» de resultados. El valor usado con el parámetro se extrae directamente de la respuesta proporcionada por la API y no se debe modificar.
​
path.pagination_token
Any or None
predeterminado:"None"
Este parámetro se usa para obtener la siguiente «página» de resultados. El valor usado con el parámetro se extrae directamente de la respuesta proporcionada por la API y no se debe modificar.
​
path.sort_order
str or None
predeterminado:"None"
El orden en el que se devolverán los resultados.
​
path.tweet_fields
List or None
predeterminado:"None"
Una lista separada por comas de campos de Tweet que se mostrarán.
​
path.expansions
List or None
predeterminado:"None"
Una lista separada por comas de campos que se expandirán.
​
path.media_fields
List or None
predeterminado:"None"
Una lista separada por comas de campos de medios que se mostrarán.
​
path.poll_fields
List or None
predeterminado:"None"
Una lista separada por comas de campos de encuesta que se mostrarán.
​
path.user_fields
List or None
predeterminado:"None"
Una lista separada por comas de campos de usuario que se mostrarán.
​
path.place_fields
List or None
predeterminado:"None"
Una lista separada por comas de campos de lugar que se mostrarán.

​
Valores devueltos

IteratorSearchRecentResponse