Modelo de Objetos
Tweet
id, text e created_at. Objetos Tweet também são o objeto “pai” de vários objetos filho, incluindo user, media, poll e place. Use o parâmetro de fields tweet.fields ao solicitar esses fields de nível root no objeto Tweet.
O objeto Tweet pode ser encontrado e expandido no recurso de usuário. Tweets adicionais relacionados ao Tweet solicitado também podem ser encontrados e expandidos no recurso Tweet. O objeto está disponível para expansão com ?expansions=pinned_tweet_id no recurso de usuário ou ?expansions=referenced_tweets.id no recurso Tweet para obter o objeto apenas com os fields padrão. Use a expansion com o parâmetro de fields tweet.fields ao solicitar fields adicionais para completar o objeto.
| Valor do Campo | Tipo | Descrição | Como Pode Ser Usado |
|---|---|---|---|
| id (padrão) | string | O identificador único do Tweet solicitado. | Use para recuperar programaticamente um Tweet específico. |
| text (padrão) | string | O texto UTF-8 real do Tweet. Consulte twitter-text para detalhes sobre caracteres válidos. | Extração de palavras-chave e análise/classificação de sentimento. |
| edit_history_tweet_ids (padrão) | object | Identificadores únicos indicando todas as versões de um Tweet. Para Tweets sem edições, haverá um ID. Para Tweets com histórico de edição, haverá múltiplos IDs. | Use esta informação para encontrar o histórico de edição de um Tweet. |
| article | object | Contém metadata para o Artigo presente neste Tweet. | Use para obter o texto e entidades de um Artigo. |
| attachments | object | Especifica o tipo de anexos (se houver) presentes neste Tweet. | Compreender os objetos retornados para expansões solicitadas. |
| author_id | string | O identificador único do Usuário que postou este Tweet. | Hidratar objeto de usuário, compartilhar conjunto de dados para revisão por pares. |
| card_uri | string | O URI para o Card presente neste tweet. | |
| community_id | string | O identificador único para a Comunidade à qual este Post pertence. | |
| context_annotations | array | Contém anotações de contexto para o Tweet. | Reconhecimento/extração de entidades, análise tópica. |
| conversation_id | string | O ID do Tweet original da conversa (que inclui respostas diretas, respostas de respostas). | Use para reconstruir a conversa a partir de um Tweet. |
| created_at | date (ISO 8601) | Horário de criação do Tweet. | Útil para análise de séries temporais e compreender quando um Tweet foi criado. |
| display_text_range | array | Um array contendo um índice de início e fim para a porção de texto que é exibida. | Útil para saber qual porção do texto é exibida por padrão para posts longos. |
| edit_controls | object | Indica por quanto tempo mais o Tweet pode ser editado e o número de edições restantes. | Use para determinar se um Tweet é elegível para edição. |
| entities | object | Entidades que foram analisadas do texto do Tweet. Consulte entidades em Objetos do Twitter. | Fornece informações adicionais sobre hashtags, URLs, menções, etc. |
| geo | object | Indica a localização ou lugar de um Tweet com geolocalização. | Use para determinar a localização de um Tweet com geolocalização. |
| in_reply_to_user_id | string | Se o Tweet representado for uma resposta, este campo conterá o ID do autor do Tweet original. | Determinar se um Tweet foi em resposta a outro Tweet. |
| lang | string | Idioma do Tweet, se detectado pelo Twitter. | Classificar Tweets por idioma falado. |
| non_public_metrics | object | Métricas de engajamento não públicas para o Tweet no momento da solicitação. Requer autenticação de contexto do usuário. | Determinar impressões totais geradas para o Tweet. |
| note_tweet | object | Contém o texto completo de um Post para Posts de formato longo (>280 caracteres). | Obter o texto completo de um post. |
| organic_metrics | object | Métricas de engajamento, rastreadas em contexto orgânico, para o Tweet no momento da solicitação. Requer autenticação de contexto do usuário. | Medir engajamento orgânico para o Tweet. |
| possibly_sensitive | boolean | Indica se o conteúdo pode ser reconhecido como sensível. | Estudar circulação de certos tipos de conteúdo. |
| promoted_metrics | object | Métricas de engajamento, rastreadas em contexto promovido, para o Tweet no momento da solicitação. Requer autenticação de contexto do usuário. | Medir engajamento para o Tweet quando foi promovido. |
| public_metrics | object | Métricas de engajamento públicas para o Tweet no momento da solicitação. | Medir engajamento do Tweet. |
| referenced_tweets | array | Uma lista de Tweets aos quais este Tweet se refere, como Retweets, Tweets citados ou respostas. | Compreender aspectos conversacionais de retweets, etc. |
| reply_settings | string | Mostra quem pode responder a um determinado Tweet. As opções são “everyone”, “mentioned_users” e “followers”. | Determinar configurações de resposta da conversa para o Tweet. |
| withheld | object | Contém detalhes de retenção para conteúdo retido. | |
| scopes | object | Contém detalhes de escopo para o tweet. | Indica quem pode visualizar o post. Retornado apenas para posts promovidos. |
| media_metadata | array | Contém metadata para anexos de mídia do Tweet. | Obter metadata adicional como o alt_text de um anexo de mídia do Tweet. |
$BEARER_TOKEN pelo seu próprio Bearer Token gerado.
Usuário
user.fields.
O objeto de usuário também pode aparecer como objeto filho e ser expandido dentro do objeto Tweet. Ele está disponível para expansão com ?expansions=author_id ou ?expansions=in_reply_to_user_id para obter o objeto condensado apenas com os campos padrão. Use a expansão em conjunto com o parâmetro user.fields ao solicitar campos adicionais para completar o objeto.
| Valor do campo | Tipo | Descrição | Como pode ser usado |
|---|---|---|---|
| id (padrão) | string | O identificador único deste usuário."id": "2244994945" | Use para recuperar programaticamente informações sobre um usuário específico do Twitter. |
| name (padrão) | string | O nome do usuário, conforme definido em seu perfil. Não necessariamente o nome de uma pessoa. Normalmente limitado a 50 caracteres, mas sujeito a alterações."name": "Twitter Dev" | |
| username (padrão) | string | O nome de usuário, identificador ou alias do Twitter com o qual este usuário se identifica. Os nomes de usuário são únicos, mas sujeitos a alterações. Normalmente têm no máximo 15 caracteres, mas algumas contas históricas podem existir com nomes mais longos."username": "TwitterDev" | |
| affiliation | object | Contém detalhes sobre a afiliação de um usuário. | Pode ser usado para obter o selo de afiliado de um usuário. |
| confirmed_email | string | O email confirmado do usuário autenticado. | |
| connection_status | array | Fornece uma lista de relações entre o usuário autenticado e o usuário sendo consultado, como seguindo, seguido, solicitação de seguir enviada, solicitação de seguir recebida, bloqueando, silenciando ”connection_status”: [ “follow_request_received”, “follow_request_sent”, “blocking”, “followed_by”, “following”, “muting” ] | Pode ser usado para determinar o status da conexão entre o usuário autenticado e o usuário sendo consultado. |
| created_at | date (ISO 8601) | A data e hora UTC em que a conta do usuário foi criada no Twitter."created_at": "2013-12-14T04:35:55.000Z" | Pode ser usado para determinar há quanto tempo alguém está usando o Twitter. |
| description | string | O texto da descrição do perfil deste usuário (também conhecida como bio), se o usuário forneceu uma."description": "The voice of the X Dev team and your official source for updates, news, and events, related to the X API." | |
| entities | object | Contém detalhes sobre texto que tem um significado especial na descrição do usuário."entities": { <br/> "url": { <br/> "urls": [ <br/> { <br/> "start": 0, <br/> "end": 23, <br/> "url": "https://t.co/3ZX3TNiZCY", <br/> "expanded_url": "/content/developer-twitter/en/community", <br/> "display_url": "developer.x.com/en/community" <br/> } <br/> ] <br/> }, <br/> "description": { <br/> "urls": [ <br/> { <br/> "start": 0, <br/> "end": 23, <br/> "url": "https://t.co/3ZX3TNiZCY", <br/> "expanded_url": "/content/developer-twitter/en/community", <br/> "display_url": "developer.x.com/en/community" <br/> }, <br/> "hashtags": [ <br/> { <br/> "start": 23, <br/> "end": 30, <br/> "tag": "DevRel" <br/> }, <br/> { <br/> "start": 113, <br/> "end": 130, <br/> "tag": "BlackLivesMatter" <br/> }, <br/> "mentions": [ <br/> { <br/> "start": 0, <br/> "end": 10, <br/> "tag": "TwitterDev" <br/> }, <br/> "cashtags": [ <br/> { <br/> "start": 12, <br/> "end": 16, <br/> "tag": "twtr" <br/> } <br/> ] <br/> } <br/> } | Entidades são objetos JSON que fornecem informações adicionais sobre hashtags, URLs, menções de usuários e cashtags associados à descrição. Consulte cada entidade respectiva para mais detalhes. Todos os índices start do usuário são inclusivos, enquanto todos os índices end do usuário são exclusivos. |
| is_identity_verified | boolean | Indica se o usuário tem identidade verificada. | |
| location | string | A localização especificada no perfil do usuário, se o usuário forneceu uma. Como este é um valor de formato livre, pode não indicar uma localização válida, mas pode ser avaliado de forma aproximada ao realizar buscas com consultas de localização."location": "127.0.0.1" | |
| most_recent_tweet_id | string | Identificador único do Tweet mais recente deste usuário. | Determina o Tweet mais recente do usuário. |
| parody | boolean | Indica se esta conta de usuário possui ou não o rótulo de Paródia. | |
| pinned_tweet_id | string | Identificador único do Tweet fixado deste usuário."pinned_tweet_id": "1255542774432063488" | Determina o Tweet fixado no topo do perfil do usuário. Pode potencialmente ser usado para determinar o idioma do usuário. |
| profile_banner_url | string | A URL para o banner do perfil deste usuário, conforme mostrado no perfil do usuário."profile_banner_url": "https://pbs.twimg.com/profile_banners/1716450569358098432/1721022977" | Pode ser usado para baixar o banner do perfil deste usuário. |
| profile_image_url | string | A URL para a imagem do perfil deste usuário, conforme mostrada no perfil do usuário."profile_image_url": "https://pbs.twimg.com/profile_images/1267175364003901441/tBZNFAgA_normal.jpg" | Pode ser usado para baixar a imagem do perfil deste usuário. |
| protected | boolean | Indica se este usuário escolheu proteger seus Tweets (em outras palavras, se os Tweets deste usuário são privados)."protected": false | |
| public_metrics | object | Contém detalhes sobre a atividade deste usuário."public_metrics": { "followers_count": 507902, "following_count": 1863, "tweet_count": 3561, "listed_count": 1550 } | Pode ser usado para determinar o alcance ou influência de um usuário do X, quantificar a variedade de interesses do usuário e o nível de engajamento do usuário no X. |
| receives_your_dm | boolean | Indica se este usuário receberá ou não a mensagem direta do usuário autenticado. | |
| subscription | object | Contém detalhes sobre se o usuário está inscrito ou não no usuário autenticado. | |
| subscription_type | string | Uma string que representa o tipo de assinatura X Premium que o usuário autenticado possui. Exemplo: None, Basic, Premium,PremiumPlus. Sempre retornará None se o usuário não for o usuário autenticado. | |
| url | string | A URL especificada no perfil do usuário, se presente."url": "https://t.co/3ZX3TNiZCY" | Uma URL fornecida por um usuário do X em seu perfil. Pode ser uma página inicial, mas nem sempre é o caso. |
| verified | boolean | Indica se este usuário é um usuário verificado do X."verified": true | Indica se este usuário do X possui ou não uma conta verificada. Uma conta verificada permite que as pessoas saibam que uma conta de interesse público é autêntica. |
| verified_followers_count | string | Uma string que representa o número de seguidores verificados de um usuário. | |
| verified_type | string | Uma string que representa o tipo de verificação que um usuário possui. Exemplo: “blue”, “business”, “government” | |
| withheld | object | Contém detalhes de retenção para conteúdo retido, se aplicável. |
$BEARER_TOKEN pelo seu próprio Bearer Token gerado.
Space
host_ids, creator_id, speaker_ids, mentioned_user_ids ao parâmetro de query expansions.
Diferentemente de Tweets, Spaces são efêmeros e ficam indisponíveis após terminarem ou quando são cancelados por seu criador. Quando sua App processa dados de Spaces, você é responsável por retornar as informações mais atualizadas e deve remover dados que não estejam mais disponíveis na plataforma. Os endpoints de lookup de Spaces podem ajudar você a garantir que respeita as expectativas e a intenção dos usuários.
| Field Value | Type | Description | How it can be used |
|---|---|---|---|
| id (default) | string | O identificador exclusivo do Space solicitado."id": "1zqKVXPQhvZJB" | Identificar de forma exclusiva um Space retornado na resposta. |
| state (default) | string | Indica se o Space começou, vai começar ou terminou."state": "live" | Filtrar Spaces ao vivo ou agendados. |
| created_at | date (ISO 8601) | Horário de criação deste Space."created_at": "2021-07-04T23:12:08.000Z" | Entender quando um Space foi criado e ordenar por horário. |
| creator_id | string | Identificador exclusivo do criador do Space."creator_id": "2244994945" | |
| ended_at | date (ISO 8601) | Horário em que o Space terminou, se aplicável."ended_at": "2021-07-04T00:11:44.000Z" | Determinar quando um Space ao vivo terminou para calcular a duração. |
| host_ids | array | Identificadores exclusivos dos hosts do Space."host_ids": ["2244994945", "6253282"] | Expandir objetos de usuário, entender engajamento. |
| lang | string | Idioma do Space, se detectado."lang": "en" | Classificar Spaces por idioma. |
| is_ticketed | boolean | Indica se este é um Space com ingressos."is_ticketed": false | Destacar conteúdo de interesse. |
| invited_user_ids | array | Lista de IDs de usuários convidados como palestrantes."invited_user_ids": ["2244994945", "6253282"] | Expandir objetos de usuário, entender engajamento. |
| participant_count | integer | Número de usuários no Space, incluindo hosts e palestrantes."participant_count": 420 | Entender engajamento, criar relatórios. |
| subscriber_count | integer | Número de pessoas que definiram um lembrete para um Space."subscriber_count": 36 | Entender interesse no evento. |
| scheduled_start | date (ISO 8601) | Horário de início agendado do Space."scheduled_start": "2021-07-14T08:00:00.000Z" | Integrar com notificações de calendário. |
| speaker_ids | array | Lista de usuários que falaram em algum momento."speaker_ids": ["2244994945", "6253282"] | Expandir objetos de usuário, entender engajamento. |
| started_at | date (ISO 8601) | Horário de início efetivo de um Space."started_at": "2021-07-14T08:00:12.000Z" | Determinar a hora de início do Space. |
| title | string | Título do Space."title": "Say hello to the Space data object!" | Entender palavras‑chave, hashtags, menções. |
| topic_ids | array | IDs dos tópicos selecionados pelo criador do Space."topic_ids": ["2244994945", "6253282"] | Entender palavras‑chave, hashtags, menções. |
| updated_at | date (ISO 8601) | Última atualização da metadata do Space."updated_at": "2021-07-11T14:44:44.000Z" | Manter as informações atualizadas. |
$BEARER_TOKEN pelo seu próprio Bearer Token gerado.
List
list.fields.
O objeto List não aparece como filho de outros objetos de dados. No entanto, objetos de usuário podem ser encontrados e expandidos no recurso de usuário. Esses objetos ficam disponíveis para expansão ao adicionar owner_id ao parâmetro de query expansions. Use essa expansão com o parâmetro de campo list.fields ao solicitar campos adicionais para completar o objeto List primário e user.fields para completar o objeto expandido.
| Valor do campo | Tipo | Descrição | Como pode ser usado |
|---|---|---|---|
| id (padrão) | string | O identificador exclusivo desta List."id": "2244994945" | Use para recuperar programaticamente informações sobre uma List específica. |
| name (padrão) | string | O nome da List, conforme definido ao criar a List."name": "Twitter Lists" | |
| created_at | date (ISO 8601) | A data e hora em UTC em que a List foi criada."created_at": "2013-12-14T04:35:55.000Z" | Determine há quanto tempo uma List está no Twitter. |
| description | string | Uma breve descrição para informar os usuários sobre a List."description": "People that are active members of the Bay area cycling community on Twitter." | |
| follower_count | integer | Mostra quantos usuários seguem esta List."follower_count": 198 | |
| member_count | integer | Mostra quantos membros fazem parte desta List."member_count": 60 | |
| private | boolean | Indica se a List é privada."private": false | |
| owner_id | string | Identificador exclusivo do proprietário desta List."owner_id": "1255542774432063488" | Pode ser usado para verificar se esse usuário é proprietário de outras Lists e para expandir objetos de usuário. |
$BEARER_TOKEN pelo seu Bearer Token gerado.
Mídia
?expansions=attachments.media_keys para obter a versão condensada apenas com os campos padrão. Use a expansão junto com o parâmetro de campos media.fields ao solicitar campos adicionais para completar o objeto.
| Valor do campo | Tipo | Descrição | Como pode ser usado |
|---|---|---|---|
| media_key (default) | string | Identificador exclusivo do conteúdo de mídia expandido. "media_key": "13_1263145212760805376" | Pode ser usado para recuperar a mídia programaticamente |
| type (default) | string | Tipo de conteúdo (animated_gif, photo, video). "type": "video" | Classificar a mídia como foto, GIF ou vídeo |
| url | string | URL direta para o arquivo de mídia no X. | Retorna um objeto Media com um campo URL para fotos |
| duration_ms | integer | Disponível quando o type é video. Duração do vídeo em milissegundos. "duration_ms": 46947 | |
| height | integer | Altura deste conteúdo em pixels. "height": 1080 | |
| non_public_metrics | object | Métricas de engajamento não públicas do conteúdo de mídia no momento da solicitação. Requer autenticação com contexto do usuário. "non_public_metrics": { "playback_0_count": 1561, "playback_100_count": 116, "playback_25_count": 559, "playback_50_count": 305, "playback_75_count": 183,} | Determinar o engajamento do vídeo: quantos usuários assistiram até cada quarto do vídeo. |
| organic_metrics | object | Métricas de engajamento do conteúdo de mídia, acompanhadas em contexto orgânico, no momento da solicitação. Requer autenticação com contexto do usuário. "organic_metrics": { "playback_0_count": 1561, "playback_100_count": 116, "playback_25_count": 559, "playback_50_count": 305, "playback_75_count": 183, "view_count": 629} | Determinar o engajamento orgânico da mídia. |
| preview_image_url | string | URL da prévia estática (placeholder) deste conteúdo. "preview_image_url": "https://pbs.twimg.com/media/EYeX7akWsAIP1_1.jpg" | |
| promoted_metrics | object | Métricas de engajamento do conteúdo de mídia, acompanhadas em contexto promovido, no momento da solicitação. Requer autenticação com contexto do usuário. "promoted_metrics": { "playback_0_count": 259, "playback_100_count": 15, "playback_25_count": 113, "playback_50_count": 57, "playback_75_count": 25, "view_count": 124} | Determinar o engajamento da mídia quando o Tweet foi promovido. |
| public_metrics | object | Métricas públicas de engajamento do conteúdo de mídia no momento da solicitação. "public_metrics": { "view_count": 6865141} | Determinar o número total de visualizações do vídeo anexado ao Tweet. |
| width | integer | Largura deste conteúdo em pixels. "width": 1920 | |
| alt_text | string | Descrição de uma imagem para habilitar e dar suporte à acessibilidade. Pode ter até 1000 caracteres. No momento, o alt text só pode ser adicionado a imagens. "alt_text": "Rugged hills along the Na Pali coast on the island of Kauai" | Pode ser usado para fornecer uma descrição escrita de uma imagem caso o usuário tenha deficiência visual. |
| variants | array | Cada objeto de mídia pode ter várias variantes de exibição ou reprodução, com diferentes resoluções ou formatos. "variants": [{ "bit_rate": 632000, "content_type": "video/mp4", "url": "https://video.twimg.com/ext_tw_video/1527322141724532740/pu/vid/320x568/lnBaR2hCqE-R_90a.mp4?tag=12"}] |
attachment.media_keys é necessária. Certifique-se de substituir $BEARER_TOKEN pelo seu próprio Bearer Token gerado.
Enquete
?expansions=attachments.poll_ids para obter a versão condensada apenas com os campos padrão. Use a expansão em conjunto com o parâmetro de campos poll.fields ao solicitar campos adicionais para completar o objeto.
| Field value | Type | Description |
|---|---|---|
| id (default) | string | Identificador exclusivo da enquete expandida. |
{"id": "1199786642791452673"} | ||
| options (default) | array | Contém objetos que descrevem cada opção na enquete referenciada. |
{"options": [ { "position": 1, "label": "“C Sharp”", "votes": 795 }, { "position": 2, "label": "“C Hashtag”", "votes": 156 } ]} | ||
| duration_minutes | integer | Especifica a duração total desta enquete. |
{"duration_minutes": 1440} | ||
| end_datetime | date (ISO 8601) | Especifica a data e hora de término desta enquete. |
{"end_datetime": "2019-11-28T20:26:41.000Z"} | ||
| voting_status | string | Indica se esta enquete ainda está ativa e pode receber votos, ou se a votação já foi encerrada. |
{"voting_status": "closed"} |
attachments.poll_id é necessária. Certifique-se de substituir $BEARER_TOKEN pelo seu próprio Bearer Token gerado.
Place
?expansions=geo.place_id para obter o objeto condensado apenas com os campos padrão. Use a expansão com o parâmetro de fields: place.fields ao solicitar campos adicionais para completar o objeto.
| Field value | Type | Description | How it can be used |
|---|---|---|---|
| full_name (default) | string | Um nome de local detalhado em formato mais longo. | Classificar um Tweet por um nome de local específico |
"full_name": "Manhattan, NY" | |||
| id (default) | string | O identificador exclusivo do local expandido, se for um ponto de interesse marcado no Tweet. | Use para recuperar um local programaticamente |
"id": "01a9a39529b27f36" | |||
| contained_within | array | Retorna os identificadores de locais conhecidos que contêm o local referenciado. | |
| country | string | O nome completo do país ao qual este local pertence. | Classificar um Tweet por nome de país |
"country": "United States" | |||
| country_code | string | O código de país ISO Alpha-2 ao qual este local pertence. | Classificar um Tweet por código de país |
"country_code": "US" | |||
| geo | object | Contém detalhes do local em formato GeoJSON. | |
| `json | |||
| ”geo”: | |||
| “type”: “Feature”, | |||
| “bbox”: [ | |||
| -74.026675, | |||
| 40.683935, | |||
| -73.910408, | |||
| 40.877483 | |||
| ], | |||
| “properties”: | |||
| } | |||
| ` | |||
| name | string | O nome curto deste local. | Classificar um Tweet por um nome de local específico |
"name": "Manhattan" | |||
| place_type | string | Especifica o tipo de informação representada por este local, como o nome de uma cidade ou um ponto de interesse. | Classificar um Tweet por um tipo específico de local |
"place_type": "city" |
geo.place_id é necessária. Certifique-se de substituir $BEARER_TOKEN pelo seu próprio Bearer Token gerado.
Eventos de Mensagens diretas
- sender_id - O ID da conta que enviou a mensagem ou que convidou um participante para uma conversa em grupo
- participant_ids - Uma matriz (array) de IDs de conta. Para eventos ParticipantsJoin e ParticipantsLeave, essa matriz conterá um único ID da conta que criou o evento
- attachments - Fornece IDs de mídia para conteúdo que foi enviado à X pelo remetente
- referenced_tweets - Se uma URL de um Tweet for encontrada no field text, o ID desse Tweet é incluído na resposta
| Field value | Type | Description | How it can be used |
| id (default) | string | O identificador exclusivo do evento. ”id”: “1050118621198921728” | Use para recuperar programaticamente um evento de conversa específico (disponível com endpoints v1.1). |
| event_type (default) | string | Descreve o tipo de evento. Três tipos são atualmente compatíveis: * MessageCreate * ParticipantsJoin * ParticipantsLeave “event_type”: “MessageCreate” | Ao recuperar o histórico de uma conversa, para entender quando as mensagens foram criadas e, em conversas em grupo, quando os participantes entraram e saíram. Todos os métodos GET oferecem suporte à filtragem por tipos específicos de evento com o parâmetro de query event_type=. |
| text (default) | string | O texto UTF-8 da Mensagem direta. “text”: “Hello, just you!” | Com chatbots, pode ser usado para analisar o conteúdo das mensagens e determinar respostas automatizadas. Também pode ser usado para criar recursos de busca em conversas. |
| entities | object | Entidades extraídas do texto da MD. | Fornece informações adicionais sobre hashtags, URLs, menções etc. |
| sender_id | string | ID do Usuário que criou o evento. Para expandir esse objeto na resposta, inclua sender_id como uma expansão e use o parâmetro de query user.fields para especificar atributos do objeto de Usuário de interesse. ”sender_id”: “906948460078698496” | Recupere o objeto de Usuário de quem criou o evento MessageCreate ou ParticipantsJoin. |
| participant_ids | array (of strings) | IDs dos participantes que entram e saem de uma conversa em grupo. Também usado ao criar novas conversas em grupo. Para expandir esse objeto na resposta, inclua participant_ids como uma expansão e use o parâmetro de query user.fields para especificar atributos do objeto de Usuário de interesse. ”participant_ids”: [ “906948460078698496” ] | Usado para recuperar objetos de Usuário dos participantes que entram e saem de conversas em grupo. |
| dm_conversation_id | string | O identificador exclusivo da conversa da qual o evento faz parte. ”dm_conversation_id”: “1584988213961031680” | Use para recuperar programaticamente eventos de uma conversa e adicionar Mensagens diretas a ela. |
| created_at | date (ISO 8601) | Horário de criação (UTC) do Tweet. ”created_at”: “2019-06-04T23:12:08.000Z” | Este campo pode ser usado para entender quando uma Mensagem direta foi criada ou quando os participantes da conversa entraram ou saíram. |
| referenced_tweets | array | ID de qualquer Tweet mencionado no texto da Mensagem direta. Para expandir esse objeto na resposta, inclua referenced_tweets.id como uma expansão e use o parâmetro de query tweet.fields para especificar atributos do objeto de Tweet de interesse. ”referenced_tweets”: [ “id”: “1578868150510456833” ] | Quando Mensagens diretas fazem referência a um Tweet, esses IDs podem ser usados para buscar os detalhes do Tweet. |
| attachments | object | Para Mensagens diretas com mídia anexada, fornece a media key do conteúdo enviado (foto, vídeo ou GIF). Para expandir esse objeto na resposta, inclua attachments.media_keys como uma expansão e use o parâmetro de query media.fields para especificar atributos do objeto de mídia de interesse. Atualmente, é compatível apenas um anexo. “attachments”: “media_keys”: [ “3_1136048009270239232” ] | Para entender os objetos de mídia anexados às Mensagens diretas. |
- Atributos fundamentais do evento, como quando foi criado e de qual conversa faz parte (dm_conversation).
- O ID da conta e a descrição de quem enviou a Mensagem direta.
- O texto de qualquer Tweet referenciado e quando foi publicado.
- O ID da conta e a descrição de qualquer autor de Tweet referenciado.
?dm_event.fields=id,sender_id,text,created_at,dm_conversation_id&expansions=sender_id,referenced_tweets.id&tweet.fields=created_at,text,author_id&user.fields=description
Comunidade
| Field value | Type | Description | |
|---|---|---|---|
| created_at | date (ISO 8601) | Horário de criação da Comunidade. | |
| id | string | O identificador exclusivo da Comunidade. | |
| name | string | O nome da Comunidade. | |
| description | string | O texto da descrição da Comunidade, se fornecido. | |
| access | string | O nível de acesso da Comunidade. Pode ser um dos: | |
- Public | |||
- Closed | |||
| join_policy | string | A política de adesão da Comunidade. Pode ser uma das: | |
- Open | |||
- RestrictedJoinRequestsDisabled | |||
- RestrictedJoinRequestsRequireAdminApproval | |||
- RestrictedJoinRequestsRequireModeratorApproval | |||
- SuperFollowRequired | |||
| member_count | integer | O número de membros que ingressaram na Comunidade. |
$BEARER_TOKEN pelo seu próprio Bearer Token gerado.
Como usar fields e expansions
fields e expansions na sua solicitação para receber objetos e campos adicionais na resposta.
Neste guia, solicitaremos vários campos com base na captura de tela de Tweet a seguir.
Solicitando fields e objetos adicionais.
- Identifique os fields adicionais que deseja solicitar usando nosso modelo de objeto ou consultando a lista de fields nas páginas de referência da API dos endpoints. Neste caso, solicitaremos os seguintes fields adicionais: attachments, author_id, created_at, public_metrics.
-
Construa o parâmetro de query
tweet.fieldsusando os campos acima como valor, em uma lista separada por vírgulas:?tweet.fields=attachments,author_id,created_at,public_metrics - Adicione o parâmetro query à solicitação GET /tweets que você realizou anteriormente.
curl --request GET --url 'https://api.x.com/2/tweets?ids=1260294888811347969&tweet.fields=attachments,author_id,created_at,public_metrics' \ --header 'Authorization: Bearer $BEARER_TOKEN'
Resposta:
- Em seguida, vamos solicitar campos relacionados ao vídeo que foi incluído no Tweet. Para isso, usaremos o parâmetro
expansionscomattachments.media_keyscomo valor e adicionaremos isso à requisição.
- E por fim, vamos solicitar a contagem de visualizações e a duração do vídeo. Estes não são fields padrão, então precisamos solicitá-los especificamente. Use o parâmetro
media.fieldscom os valores separados por vírgula,public_metricseduration_msem sua requisição.
curl --request GET --url 'https://api.x.com/2/tweets?ids=1260294888811347969&tweet.fields=attachments,author_id,created_at,public_metrics&expansions=attachments.media_keys&media.fields=duration_ms,public_metrics' --header 'Authorization: Bearer $BEARER_TOKEN'
Resposta, que agora inclui todos os dados visíveis na captura de tela do Tweet:
- ids=1260294888811347969
- tweet.fields=attachments,author_id,created_at,public_metrics
- expansions=attachments.media_keys
- media.fields=public_metrics,duration_ms