tweepy.API
— Twitter API v1.1 Reference¶
- class tweepy.API(auth=None, *, cache=None, host='api.twitter.com', parser=None, proxy=None, retry_count=0, retry_delay=0, retry_errors=None, timeout=60, upload_host='upload.twitter.com', user_agent=None, wait_on_rate_limit=False)¶
Twitter API v1.1 Interface
- Parametry
auth – Handler autentykacji, który zostanie użyty
cache – Pamieć podręczna do zapytania gdy użyta zostaje metoda GET
host – Generaly REST API hosta serwera URL
parser – Instancja Parser, do uzycia podczas parsowania odpowiedzi od Twittera; domyślnie instancja ModelParser
proxy – Pełen url proxy HTTPS, które jest użyte do połączenia z Twitter
retry_count – Liczba powtórzeń gdy wystąpi błąd
retry_delay – Liczba sekund oczekiwania pomiędzy powtórzeniami
retry_errors – Który kod statusu HTTP zostanie użyty do powtórzenia
timeout – Maksymalna ilość czasu oczekiwania na odpowiedź od Twitter
upload_host – URL serwera upload
wait_on_rate_limit – Czy automatycznie oczekiwać na wyczerpanie limitów wskaźników
- Wyrzuca
TypeError – Co jeżeli dany parser nie jest instancją Parser
References
Twitter API v1.1 Endpoint |
|
---|---|
Tweety¶
Uzyskaj osie czasów Tweeta¶
- API.home_timeline(*, count, since_id, max_id, trim_user, exclude_replies, include_entities)¶
Zwraca 20 ostatnich statusów w tym retweety zapostowane przez zuwierzytelnionego użytkownika i jego znajomych. Jest to to samo co /timeline/home.
- Parametry
count – Liczba wyników do pobrania na stronę
since_id – Zwraca tylko statusy z ID większym (tzn. nowszym) niż określone ID
max_id – Zwraca tylko statusy z ID mniejszym (tzn. starszym) lub równym określonemu ID
trim_user – Boolean wskazujacy czy dostarczyć ID użytkowników zamiast kompletnych obiektów user. Domyślnie False
exclude_replies – Ustawione jako false powoduje, że węzeł jednostek nie będzie zawarty. Domyślnie False
include_entities – Ustawione jako false powoduje, że węzeł jednostek nie będzie zawarty. Domyślnie False
- Zwraca
- Typ zwracany
List
[Status
]
References
- API.mentions_timeline(*, count, since_id, max_id, trim_user, include_entities)¶
Zwraca 20 najnowszych wzmianek, w tym retweety.
- Parametry
count – Liczba wyników do pobrania na stronę
since_id – Zwraca tylko statusy z ID większym (tzn. nowszym) niż określone ID
max_id – Zwraca tylko statusy z ID mniejszym (tzn. starszym) lub równym określonemu ID
trim_user – Boolean wskazujacy czy dostarczyć ID użytkowników zamiast kompletnych obiektów user. Domyślnie False
include_entities – Ustawione jako false powoduje, że węzeł jednostek nie będzie zawarty. Domyślnie False
- Zwraca
- Typ zwracany
List
[Status
]
References
- API.user_timeline(*, user_id, screen_name, since_id, count, max_id, trim_user, exclude_replies, include_rts)¶
Zwraca 20 ostatnich statusów zapostowanych przez zuwierzytelnionego użytkownika lub wyznaczonego użytkownika. Możliwe jest także zażądanie osi czasu innego użytkownika za pomocą parametru id.
- Parametry
user_id – Określa ID użytkownika. Przydatne do rozróżnienia czy nazwa wyświetlana jest taka sama jak ID użytkownika
screen_name – Określa nazwę wyświetlaną użytkownika. Przydatne do rozróżnienia czy nazwa wyświetlana jest taka sama jak ID użytkownika
since_id – Zwraca tylko statusy z ID większym (tzn. nowszym) niż określone ID
count – Liczba wyników do pobrania na stronę
max_id – Zwraca tylko statusy z ID mniejszym (tzn. starszym) lub równym określonemu ID
trim_user – Boolean wskazujacy czy dostarczyć ID użytkowników zamiast kompletnych obiektów user. Domyślnie False
exclude_replies – Ustawione jako false powoduje, że węzeł jednostek nie będzie zawarty. Domyślnie False
include_rts – Kiedy ustawiony na
false
, oś czasu usunie wszystkie natywne retweety (choć nadal będą się one liczyć zarówno do maksymalnej długości osi czasu jak i do wycinka wybranego przez parametr count). Uwaga: Jeśli używasz parametru trim_user w połączeniu z include_rts, retweety nadal będą zawierały pełny obiekt użytkownika.
- Zwraca
- Typ zwracany
List
[Status
]
References
Postowanie, pozyskiwanie i angażowanie się w Tweety¶
- API.get_favorites(*, user_id, screen_name, count, since_id, max_id, include_entities)¶
Zwraca ulubione statusy zuwierzytelnionego użytkownika lub użytkownika określonego przez parametr ID.
- Parametry
user_id – Określa ID użytkownika. Przydatne do rozróżnienia czy nazwa wyświetlana jest taka sama jak ID użytkownika
screen_name – Określa nazwę wyświetlaną użytkownika. Przydatne do rozróżnienia czy nazwa wyświetlana jest taka sama jak ID użytkownika
count – Liczba wyników do pobrania na stronę
since_id – Zwraca tylko statusy z ID większym (tzn. nowszym) niż określone ID
max_id – Zwraca tylko statusy z ID mniejszym (tzn. starszym) lub równym określonemu ID
include_entities – Ustawione jako false powoduje, że węzeł jednostek nie będzie zawarty. Domyślnie False
- Zwraca
- Typ zwracany
List
[Status
]
References
- API.lookup_statuses(id, *, include_entities, trim_user, map, include_ext_alt_text, include_card_uri)¶
Zwraca pełne obiekty Tweet, do 100 tweetów na jedno żądanie. Sprecyzowane w parametrze
id
.- Parametry
id – Lista ID tweetów do wyszukania, maksymalnie 100
include_entities – Ustawione jako false powoduje, że węzeł jednostek nie będzie zawarty. Domyślnie False
trim_user – Boolean wskazujacy czy dostarczyć ID użytkowników zamiast kompletnych obiektów user. Domyślnie False
map – Boolean wskazujący czy zawarte będą tweety, które nie mogą być pokazywane. Domyślnie False.
include_ext_alt_text – Jeżeli alt tekst został dodany do którejś z dołączonych jednostek to ten parametr zwróci wartość ext_alt_text w kluczu top-level dla tej jednostki mediów
include_card_uri – Boolean wkazujący czy otrzymany tweet powinien zawierać atrybut card_uri gdy do tweeta dołączona jest karta ads oraz gdy karta jest dołączona używając wartośći card_uri
- Zwraca
- Typ zwracany
List
[Status
]
References
- API.get_oembed(url, *, maxwidth, hide_media, hide_thread, omit_script, align, related, lang, theme, link_color, widget_type, dnt)¶
Zwraca pojedynczy Tweet, określony przez adres URL Tweeta lub ID Tweeta, w formacie kompatybilnym z oEmbed. Zwrócony fragment HTML zostanie automatycznie rozpoznany jako osadzony Tweet, gdy widget JavaScript Twittera jest zawarty na stronie.
Punkt końcowy oEmbed pozwala na dostosowanie ostatecznego wyglądu osadzonego Tweeta poprzez ustawienie odpowiednich właściwości w znacznikach HTML, które będą domyślnie interpretowane przez JavaScript Twittera dołączony do odpowiedzi HTML. Format zwróconego znacznika może się zmienić, gdyż Twitter dodaje nowe funkcje lub dostosowuje swoją reprezentację Tweetów.
Znacznik Tweet fallback jest przeznaczony do zapisywania w pomięci podręcznej na Twoich serwerach przez sugerowany czas życia pamięci podany w
cache_age
.- Parametry
url – ID zapisanego wyszukania które ma zostać usunięte
maxwidth – Maksymalna szerokość renderowanego Tweeta w całych pikselach. Dostarczona wartość poniżej lub powyżej dozwolonego zakresu zostanie zwrócona odpowiednio jako minimalna lub maksymalna obsługiwana szerokość; zresetowana wartość szerokości zostanie odzwierciedlona w zwróconej właściwości
width
. Twitter nie obsługuje parametru oEmbedmaxheight
. Tweety są zasadniczo tekstem, a zatem mają nieprzewidywalną wysokość, która nie może być skalowana jak obraz lub wideo. W związku z tym, odpowiedź oEmbed nie dostarczy wartości dla parametruheight
. Implementacje, które potrzebują spójnej wysokości dla Tweetów powinny odnieść się do parametrówhide_thread
ihide_media
poniżej.hide_media – Gdy ustawione na
true
,"t"
, lub1
, linki w tweecie nie są rozszerzone o zdjęcia, wideo lub podgląd linków.hide_thread – Gdy ustawione na
true
,"t"
, lub1
, skrócona wersja poprzedniego Tweeta w wątku konwersacji nie będzie wyświetlana, gdy żądany Tweet jest odpowiedzią na innego Tweeta.omit_script – Kiedy ustawiony na
true
,"t"
, lub1
,<script>
odpowiedzialny za ładowaniewidgets.js
nie zostanie zwrócony. Twoje strony internetowe powinny zawierać własne odniesienie dowidgets.js
do użytku we wszystkich widżetach Twittera, w tym w osadzonych tweetach.align – Określa, czy osadzony Tweet powinien być spławiany w lewo, w prawo lub na środku strony względem elementu nadrzędnego.
related – Oddzielona przecinkami lista nazw użytkowników Twittera związanych z twoją treścią. Ta wartość zostanie przekazana do intencji akcji Tweet, jeśli użytkownik zdecyduje się odpowiedzieć, polubić lub retweetować osadzonego Tweeta.
lang – Żądanie zwrócenia HTML i wyrenderowanego Tweeta w określonym języku Twittera obsługiwanym przez osadzone Tweety.
theme – Kiedy ustawiony na
dark
, Tweet jest wyświetlany z jasnym tekstem na ciemnym tle.link_color – Dostosuj kolor linków tekstowych Tweeta za pomocą szesnastkowej wartości koloru.
widget_type – Ustaw jako
video
aby zwrócić embed Twitter Video dla danego Tweeta.dnt – Po ustawieniu na
true
, Tweet i jego osadzona strona na Twojej stronie nie są używane do celów, które obejmują spersonalizowane sugestie i spersonalizowane reklamy.
- Zwraca
JSON
- Typ zwracany
References
- API.get_retweeter_ids(id, *, count, cursor, stringify_ids)¶
Zwraca maksymalnie 100 ID użytkowników, należących do użytkowników, którzy zretweetowali Tweeta określonego przez paremetr
id
.- Parametry
id – Numeryczne ID statusu
count – Liczba wyników do pobrania na stronę
cursor – Dzieli wyniki na strony. Ustaw wartość jako -1 by rozpocząć stronnicowanie. Dostarcz wartości tak jak są zwracane w tekście opowiedzi. Atrybuty next_cursor i previous_cursor używane są do przechoznenia na przód i w tył
stringify_ids – Zwraca tylko statusy z ID większym (tzn. nowszym) niż określone ID
- Zwraca
- Typ zwracany
List
[int
]
References
- API.get_retweets(id, *, count, trim_user)¶
Zwraca do 100 pierwszych retweetów wybranego tweeta.
- Parametry
id – Numeryczne ID statusu
count – Liczba wyników do pobrania na stronę
trim_user – Boolean wskazujacy czy dostarczyć ID użytkowników zamiast kompletnych obiektów user. Domyślnie False
- Zwraca
- Typ zwracany
List
[Status
]
References
- API.get_retweets_of_me(*, count, since_id, max_id, trim_user, include_entities, include_user_entities)¶
Zwraca 20 najnowszych tweetów od zuwierzytelnionego użytkownika, które zostały zretweetowane przez innych użytkowników.
- Parametry
count – Liczba wyników do pobrania na stronę
since_id – Zwraca tylko statusy z ID większym (tzn. nowszym) niż określone ID
max_id – Zwraca tylko statusy z ID mniejszym (tzn. starszym) lub równym określonemu ID
trim_user – Boolean wskazujacy czy dostarczyć ID użytkowników zamiast kompletnych obiektów user. Domyślnie False
include_entities – Ustawione jako false powoduje, że węzeł jednostek nie będzie zawarty. Domyślnie False
include_user_entities – Gdy ustawione jako False to jednostki węzła obiektu user nie będą zawarte. Domyślnie True
- Zwraca
- Typ zwracany
List
[Status
]
References
- API.get_status(id, *, trim_user, include_my_retweet, include_entities, include_ext_alt_text, include_card_uri)¶
Zwraca pojedyńczy status określony przez parametr ID.
- Parametry
id – Numeryczne ID statusu
trim_user – Boolean wskazujacy czy dostarczyć ID użytkowników zamiast kompletnych obiektów user. Domyślnie False
include_my_retweet – Boolean wskazujący czy tweety, które zostały zretweetowane przez zuwierzytelnionego użytkownika powinny zawierać dodatkowy węzeł current_user_retweet, który zawiera ID statusu źródłowego dla retweeta.
include_entities – Ustawione jako false powoduje, że węzeł jednostek nie będzie zawarty. Domyślnie False
include_ext_alt_text – Jeżeli alt tekst został dodany do którejś z dołączonych jednostek to ten parametr zwróci wartość ext_alt_text w kluczu top-level dla tej jednostki mediów
include_card_uri – Boolean wkazujący czy otrzymany tweet powinien zawierać atrybut card_uri gdy do tweeta dołączona jest karta ads oraz gdy karta jest dołączona używając wartośći card_uri
- Zwraca
- Typ zwracany
References
- API.create_favorite(id, *, include_entities)¶
Ustawia jako ulubione statusy określone przez parametr
id
jako zuwierzytelniony użytkownik.- Parametry
id – Numeryczne ID statusu
include_entities – Ustawione jako false powoduje, że węzeł jednostek nie będzie zawarty. Domyślnie False
- Zwraca
- Typ zwracany
References
- API.destroy_favorite(id, *, include_entities)¶
Usuwa z ulubionych statusy określone przez parametr
id
jako zuwierzytelniony użytkownik.- Parametry
id – Numeryczne ID statusu
include_entities – Ustawione jako false powoduje, że węzeł jednostek nie będzie zawarty. Domyślnie False
- Zwraca
- Typ zwracany
References
- API.destroy_status(id, *, trim_user)¶
Niszczy status określony przez parametr
id
. Zuwierzytelniony użytkownik musi być autorem statusu by go zniszczyć.- Parametry
id – Numeryczne ID statusu
trim_user – Boolean wskazujacy czy dostarczyć ID użytkowników zamiast kompletnych obiektów user. Domyślnie False
- Zwraca
- Typ zwracany
References
- API.retweet(id, *, trim_user)¶
Retweetuje tweet. Wymaga ID tweeta, który retweetujesz.
- Parametry
id – Numeryczne ID statusu
trim_user – Boolean wskazujacy czy dostarczyć ID użytkowników zamiast kompletnych obiektów user. Domyślnie False
- Zwraca
- Typ zwracany
References
- API.unretweet(id, *, trim_user)¶
Odtweetowuje zretweetowany status. Wymaga ID retweeta.
- Parametry
id – Numeryczne ID statusu
trim_user – Boolean wskazujacy czy dostarczyć ID użytkowników zamiast kompletnych obiektów user. Domyślnie False
- Zwraca
- Typ zwracany
References
- API.update_status(status, *, in_reply_to_status_id, auto_populate_reply_metadata, exclude_reply_user_ids, attachment_url, media_ids, possibly_sensitive, lat, long, place_id, display_coordinates, trim_user, card_uri)¶
Aktualizuje status zuwierzytelnionego użytkownika.
Dla każdej próby aktualizacji, jej tekst jest porównywany z najnowszym tweetem zuwierzytelnionego użytkownika. Każda próba, której rezultatem był by duplikat, zostanie zablokowana, co spowoduje wystąpienie błędu 403. Użytkownik nie może wysłać tego samego statusu dwa razy pod rząd.
Mimo, że nie jest to limitowane przez API, użytkownik może stworzyć maksymalnie określoną liczbę tweetów za jednym razem. Jeżeli liczba aktualizacji zapostowana przez użytkownika osiągnie aktualny limit, metoda tha zwróci błąd HTTP 403.
- Parametry
status – Tekst statusu aktualizacji.
in_reply_to_status_id – ID istniejącego statusu dla którego odpowiada aktualizacja. Uwaga: Ten parametr zostanie zignorowany, chyba, że autor tweeta, do którego się odnosi jest wspomniany w ramach tekstu statusu. Tak więc w aktualizacji musisz zawrzeć @username, gdzie username jest autorem wspomnianego tweeta.
auto_populate_reply_metadata – Jeżeli ustawione jako true i użyte w in_reply_to_status_id, głowne @mentions będą wyszukane w oryginalnym tweecie i dodane do nowego tweeta. To dołączy @mentions do metaaty istniejącego tweeta wraz z rozwojem łańcucha tweetów, póki nie zostanie osiągnięty limit @mentions. Odpowiedź nie powiedzie się, w przypadkach gdzie oryginalny tweet został usunięty.
exclude_reply_user_ids – Gdy użyte z auto_populate_reply_metadata, lista ID użytkowników oddzielona przecinkami zostanie usunięta z wygenerowanego przez serwer prefiksu @mentions na rozszerzonym tweecie. Zauważ, że główne @mention nie mogą być usunięte ponieważ zepsuło by to semantykę in-reply-to-status-id. Próby ich usunięcia będą dyskretnie zignorowane.
attachment_url – Aby URL nie był policzony w treść statusu rozszerzonego tweeta, dołacz go jako załącznik. URL ten musi być permalinkiem tweeta lub linkiem Wiadomości Bezpośredniej. Inne nie-twitterowe URL muszą pozostać w tekście statusu. URL przekazane do parametru attachment_url, które nie są przyporządkowane do permalinku tweeta lub Wiadomości Bezpośredniej, nie stworzą tweeta i spowodują wystąpienie wyjątku.
media_ids – Lista media_ids powiązanych z Tweetem. Jeden Tweet może zawierać maksymalnie 4 zdjęcia, 1 animowany GIF lub 1 video.
possibly_sensitive – Jeżeli prześlesz media tweeta, które mogą zawierać wrażliwy kontent taki jak nagość lub procedury medyczne to ta wartość musi być ustawiona jako true.
lat – Szerokość geograficzna lokacji do której odnosi się tweet. Ten parametr zostanie zignorowany, chyba, że znajduje się pomiędzy -90.0 a +90.0 (północ to wartość dodatnia). Zostanie on także zignorowany jeżeli nie ma on dopasowanego parametru długości geograficznej.
long – Długość geograficzna do której odnosi się tweet. Poprawne wartości zawieraja się między -180.0 a +180.0 (wschód to wartość dodatnia). Ten parametr zostanie zignorowany jeżeli przekracza ten zakres, nie jest liczbą, gdy geo_enabled jest wyłączone oraz jeżeli nie ma dopasowanego parametru szerokości geograficznej.
place_id – Miejsce gdzieś na świecie.
display_coordinates – Czy wbić szpilkę w miejsce o dokładnych koordynatach, z których został wysłany Tweet.
trim_user – Boolean wskazujacy czy dostarczyć ID użytkowników zamiast kompletnych obiektów user. Domyślnie False
card_uri – Powiązuje karte reklamową z tweetem używając wartości card_uri z jakiejkolwiek odpowiedzi od karty reklamowej.
- Zwraca
- Typ zwracany
References
- API.update_status_with_media(status, filename, *, file, possibly_sensitive, in_reply_to_status_id, lat, long, place_id, display_coordinates)¶
Niezalecane od wersji 3.7.0: Użyj
API.media_upload()
.Aktualizuje status zuwierzytelnionego użytkownika. Statusy, które są duplikatami lub są zbyt długie, będą ignorowane.
- Parametry
status – Tekst statusu aktualizacji.
filename – Określa nazwę wyświetlaną użytkownika. Przydatne do rozróżnienia czy nazwa wyświetlana jest taka sama jak ID użytkownika
file – Lista ID tweetów do wyszukania, maksymalnie 100
possibly_sensitive – Oznacz jako true w przypadku treści nieodpowiednich dla wszystkich.
in_reply_to_status_id – ID istniejącego już statusu, dla ktorego aktualizacja jest odpowiedzią.
lat – Szerokość geograficzna do której odnosi się tweet.
long – Długość geograficzna do której odnosi się tweet.
place_id – Twitter ID lokacji, która jest wymieniona w tweecie gdy użytkownik ma włączoną geolokację.
display_coordinates – Czy wbić szpilkę w miejsce o dokładnych koordynatach, z których został wysłany Tweet.
- Zwraca
- Typ zwracany
References
Szuaknie Tweetów¶
- API.search_tweets(q, *, geocode, lang, locale, result_type, count, until, since_id, max_id, include_entities)¶
Zwraca zbiór odpowiednich tweetów pasujących do określonego zapytania.
Proszę miej na uwadze, że usługa wyszukiwania Twittera oraz Search API nie są w założeniu pełnym źródłem tweetów. Nie wszystkie tweety będą zindeksowane lub udostępnione przez wyszukiwarkę.
W API v1.1 format odpowiedzi dla Search API został udoskonalony tak by zwracał obiekty tweetów podobnie jak obiekty, które możesz znaleśść w REST API oraz platformie. Jednakże, atrybuty perspektywiczne (pola które odnoszą się do perspektywy zuwierzytelnionego użytkownika) nie są na tą chwilę wspierane w tym punkcie końcowym.12
- Parametry
q – The search query string of 500 characters maximum, including operators. Queries may additionally be limited by complexity.
geocode – Zwraca tweety w oparciu o lokalizacje użytkownika wewnątrz promienia podanej szerokości/długości geograficznej. Lokacja domyślnie jest pobierana z Geotagging API, lecz zostanie cofnięta do profilu Twitter. Wartość parametru jest określona przez „szerokość,długość,promień” gdzie jednostki promienia muszą być określone jako „mi” (mile) lub „km” (kilometry). Uwaga: nie możesz użyć pobliskiego operatora poprzez API by zgeokodyfikować przypadkowe lokacje; jenakże możesz użyć tego parametru geocode do wyszukania geokodów bezpośrednio. Maksymalnie 1000 różnych „podregionów” będzie brane pod uwagę używajac modyfikatora promienia.
lang – Ogranicza tweey to podanego języka, nadanego przez kod ISO 639-1. Detekcja języka jest best-effort.
locale – Określa język zapytania, które będzie wysłane (na tę chwię tylko „ja”). Jesto skierowane do konsumentów posiadających szczególne wymagania językowe. Domyślnie działa w większości przypadków.
result_type – Określa jaki typ wyników wyszukiwania chciałbyś otrzymywać. Domyślnie „mixed”. Poprawne wartości zawierają: * mixed : zawiera wyniki popularne oraz w czasie rzeczywistym *recent : zwraca tylko najnowsze wyniki * popular : zwraca tylko popularne wyniki
count – Liczba wyników do pobrania na stronę
until – Zwraca tweety stworzone przed określoną datą. Data powinna być w formacie YYYY-MM-DD. Miej na uwadze, że indeks wyszukiwania ma 7-dniowy limit. Innymi słowami, nie zostaną znalezione żadne tweety starsze niż tydzień.
since_id – Zwraca tylko statusy z ID większym (tzn. nowszym) niż określone ID. Liczba tweetów, które są dostępne w API jst limitowana. Jeżeli limit tweetów wydarzył się od since_id to since_id będzie najstarzym dostępnym ID.
max_id – Zwraca tylko statusy z ID mniejszym (tzn. starszym) lub równym określonemu ID
include_entities – Ustawione jako false powoduje, że węzeł jednostek nie będzie zawarty. Domyślnie False
- Zwraca
- Typ zwracany
SearchResults
References
https://developer.twitter.com/en/docs/twitter-api/v1/tweets/search/api-reference/get-search-tweets
Konta i użytkownicy¶
Tworzenie i zarządzanie listami¶
- API.get_lists(*, user_id, screen_name, reverse)¶
Zwraca wszystkie listy, które subskrybuje zuwierzytelniony lub określony użytkownik, w tym ich własne. Użytkownik określony jest poprzez parametry
user_id
lubscreen name
. Jeżeli użytkownik nie jest podany to zostanie wtedy użyty zuwierzytelniony użytkownik.Maksymalnie 100 wyników może być zwrócone przez to wywołanie. Listy subskrybowane są zwrócone jako pirwsze, tuż za nimi listy posiadane na własność. To oznacza, że jeżeli użytkownik subsrybuje 90 list i posiada 20 list to ta metoa zwróci 90 list subskrybowanych i 10 list posiadanych. Metoda
reverse
zwraca posiadane listy jako pierwsze, tak więc z ustawieniemreverse=true
zwrócone będzie 20 list posiadanych i 80 subskrybowanych.- Parametry
user_id – Określa ID użytkownika. Przydatne do rozróżnienia czy nazwa wyświetlana jest taka sama jak ID użytkownika
screen_name – Określa nazwę wyświetlaną użytkownika. Przydatne do rozróżnienia czy nazwa wyświetlana jest taka sama jak ID użytkownika
reverse – Boolean wskazujący czy chiałbyś by posiadane na własność listy zostały zwrócone jako pierwsze. Zobacz opis powyżej po więcej informacji na temat tego parametru.
- Zwraca
- Typ zwracany
List
[List
]
References
- API.get_list_members(*, list_id, slug, owner_screen_name, owner_id, count, cursor, include_entities, skip_status)¶
Zwraca użytkowników z określonej listy.
- Parametry
list_id – Numeryczna lista ID
slug – Możesz zidentyfikować listę używając jej slug zamiast numerycznego ID. Jeżeli się na to zdecydujesz to będziesz musiał określić właściciela listy używając parametrów owner_id lub owner_screen_name
owner_screen_name – Nazwa wyświetlana użytkownika, który jest właścicielem listy żądanej przez slug
owner_id – ID użytkownika, który jest właścicielem listy żadanej przez slug
count – Liczba wyników do pobrania na stronę
cursor – Dzieli wyniki na strony. Ustaw wartość jako -1 by rozpocząć stronnicowanie. Dostarcz wartości tak jak są zwracane w tekście opowiedzi. Atrybuty next_cursor i previous_cursor używane są do przechoznenia na przód i w tył
include_entities – Ustawione jako false powoduje, że węzeł jednostek nie będzie zawarty. Domyślnie False
skip_status – Boolean wskazujący czy będą zawarte w zwróconych obiektach user. Domyślnie False
- Zwraca
- Typ zwracany
List
[User
]
References
- API.get_list_member(*, list_id, slug, user_id, screen_name, owner_screen_name, owner_id, include_entities, skip_status)¶
Sprawdza czy określony użytkownik jest członkiem określonej listy.
- Parametry
list_id – Numeryczna lista ID
slug – Możesz zidentyfikować listę używając jej slug zamiast numerycznego ID. Jeżeli się na to zdecydujesz to będziesz musiał określić właściciela listy używając parametrów owner_id lub owner_screen_name
user_id – Określa ID użytkownika. Przydatne do rozróżnienia czy nazwa wyświetlana jest taka sama jak ID użytkownika
screen_name – Określa nazwę wyświetlaną użytkownika. Przydatne do rozróżnienia czy nazwa wyświetlana jest taka sama jak ID użytkownika
owner_screen_name – Nazwa wyświetlana użytkownika, który jest właścicielem listy żądanej przez slug
owner_id – ID użytkownika, który jest właścicielem listy żadanej przez slug
include_entities – Ustawione jako false powoduje, że węzeł jednostek nie będzie zawarty. Domyślnie False
skip_status – Boolean wskazujący czy będą zawarte w zwróconych obiektach user. Domyślnie False
- Wyrzuca
NotFound – The user is not a member of the list.
- Zwraca
- Typ zwracany
References
- API.get_list_memberships(*, user_id, screen_name, count, cursor, filter_to_owned_lists)¶
Zwraca listy, do których został dodany wybrany użytkownik. Jeżeli
user_id
lubscreen_name
nie są podane to zwracane jest członkostwo dla zuwierzytelnionego użytkownika.- Parametry
user_id – Określa ID użytkownika. Przydatne do rozróżnienia czy nazwa wyświetlana jest taka sama jak ID użytkownika
screen_name – Określa nazwę wyświetlaną użytkownika. Przydatne do rozróżnienia czy nazwa wyświetlana jest taka sama jak ID użytkownika
count – Liczba wyników do pobrania na stronę
cursor – Dzieli wyniki na strony. Ustaw wartość jako -1 by rozpocząć stronnicowanie. Dostarcz wartości tak jak są zwracane w tekście opowiedzi. Atrybuty next_cursor i previous_cursor używane są do przechoznenia na przód i w tył
filter_to_owned_lists – Boolean wskazujący czy zwrócić tylko listy, które posiada zuwierzytelniony użytkownik oraz użytkownik reprezentowany przez
user_id
lubscreen_name
.
- Zwraca
- Typ zwracany
List
[List
]
References
- API.get_list_ownerships(*, user_id, screen_name, count, cursor)¶
Zwraca listy, które są własnością określonego użytkownika. Prywatne listy będa pokazne tylko jeżeli zuwierzytelniony użytkownik jest ich właścicielem. Jeżeli
user_id
orazscreen_name
nie są określone to zwrócone zostaną te, któe są posiadane przez zuwierzytelnionego użytkownika.- Parametry
user_id – Określa ID użytkownika. Przydatne do rozróżnienia czy nazwa wyświetlana jest taka sama jak ID użytkownika
screen_name – Określa nazwę wyświetlaną użytkownika. Przydatne do rozróżnienia czy nazwa wyświetlana jest taka sama jak ID użytkownika
count – Liczba wyników do pobrania na stronę
cursor – Dzieli wyniki na strony. Ustaw wartość jako -1 by rozpocząć stronnicowanie. Dostarcz wartości tak jak są zwracane w tekście opowiedzi. Atrybuty next_cursor i previous_cursor używane są do przechoznenia na przód i w tył
- Zwraca
- Typ zwracany
List
[List
]
References
- API.get_list(*, list_id, slug, owner_screen_name, owner_id)¶
Zwraca wybraną listę. Prywate listy będą pokazane tylko jeżeli zuwierzytelniony użytkownik jest ich właścicielem.
- Parametry
list_id – Numeryczna lista ID
slug – Możesz zidentyfikować listę używając jej slug zamiast numerycznego ID. Jeżeli się na to zdecydujesz to będziesz musiał określić właściciela listy używając parametrów owner_id lub owner_screen_name
owner_screen_name – Nazwa wyświetlana użytkownika, który jest właścicielem listy żądanej przez slug
owner_id – ID użytkownika, który jest właścicielem listy żadanej przez slug
- Zwraca
- Typ zwracany
References
- API.list_timeline(*, list_id, slug, owner_screen_name, owner_id, since_id, max_id, count, include_entities, include_rts)¶
Zwraca oś czasu Tweetów, których autorami są członkowie wybranej listy. Domyślnie zawiera retweety. Użyj parametru
include_rts=false
by pominąć retweety.- Parametry
list_id – Numeryczna lista ID
slug – Możesz zidentyfikować listę używając jej slug zamiast numerycznego ID. Jeżeli się na to zdecydujesz to będziesz musiał określić właściciela listy używając parametrów owner_id lub owner_screen_name
owner_screen_name – Nazwa wyświetlana użytkownika, który jest właścicielem listy żądanej przez slug
owner_id – ID użytkownika, który jest właścicielem listy żadanej przez slug
since_id – Zwraca tylko statusy z ID większym (tzn. nowszym) niż określone ID
max_id – Zwraca tylko statusy z ID mniejszym (tzn. starszym) lub równym określonemu ID
count – Liczba wyników do pobrania na stronę
include_entities – Ustawione jako false powoduje, że węzeł jednostek nie będzie zawarty. Domyślnie False
include_rts – Boolean wskazujący czy oś czasu listy będzie zawierać natywne retweety (jeżeli istnieją) w dodatku do standardowego strumienia tweetów. Format wyjścia reteetowanych Tweetów jest identyczny do tego widocznego w home_timeline.
- Zwraca
- Typ zwracany
List
[Status
]
References
- API.get_list_subscribers(*, list_id, slug, owner_screen_name, owner_id, count, cursor, include_entities, skip_status)¶
Zwraca subskrybentów wybranej listy. Subskrybenci prywatnych list będą wyświetleni tylko jeżeli zuwierzytelniony użytkownik jest właścicielem listy.
- Parametry
list_id – Numeryczna lista ID
slug – Możesz zidentyfikować listę używając jej slug zamiast numerycznego ID. Jeżeli się na to zdecydujesz to będziesz musiał określić właściciela listy używając parametrów owner_id lub owner_screen_name
owner_screen_name – Nazwa wyświetlana użytkownika, który jest właścicielem listy żądanej przez slug
owner_id – ID użytkownika, który jest właścicielem listy żadanej przez slug
count – Liczba wyników do pobrania na stronę
cursor – Dzieli wyniki na strony. Ustaw wartość jako -1 by rozpocząć stronnicowanie. Dostarcz wartości tak jak są zwracane w tekście opowiedzi. Atrybuty next_cursor i previous_cursor używane są do przechoznenia na przód i w tył
include_entities – Ustawione jako false powoduje, że węzeł jednostek nie będzie zawarty. Domyślnie False
skip_status – Boolean wskazujący czy będą zawarte w zwróconych obiektach user. Domyślnie False
- Zwraca
- Typ zwracany
List
[User
]
References
- API.get_list_subscriber(*, owner_screen_name, owner_id, list_id, slug, user_id, screen_name, include_entities, skip_status)¶
Sprawdza czy określony użytkownik jest subskrybentem określonej listy.
- Parametry
owner_screen_name – Nazwa wyświetlana użytkownika, który jest właścicielem listy żądanej przez slug
owner_id – ID użytkownika, który jest właścicielem listy żadanej przez slug
list_id – Numeryczna lista ID
slug – Możesz zidentyfikować listę używając jej slug zamiast numerycznego ID. Jeżeli się na to zdecydujesz to będziesz musiał określić właściciela listy używając parametrów owner_id lub owner_screen_name
user_id – Określa ID użytkownika. Przydatne do rozróżnienia czy nazwa wyświetlana jest taka sama jak ID użytkownika
screen_name – Określa nazwę wyświetlaną użytkownika. Przydatne do rozróżnienia czy nazwa wyświetlana jest taka sama jak ID użytkownika
include_entities – Ustawione jako false powoduje, że węzeł jednostek nie będzie zawarty. Domyślnie False
skip_status – Boolean wskazujący czy będą zawarte w zwróconych obiektach user. Domyślnie False
- Wyrzuca
NotFound – The user is not a subscriber of the list.
- Zwraca
- Typ zwracany
References
- API.get_list_subscriptions(*, user_id, screen_name, count, cursor)¶
Zdobywa kolekcję list do którye subskrybuje wybrany użytkownnik, domyślnie 20 list na jedną stronę. Nie zawiera list posiadanych przez użytkownika.
- Parametry
user_id – Określa ID użytkownika. Przydatne do rozróżnienia czy nazwa wyświetlana jest taka sama jak ID użytkownika
screen_name – Określa nazwę wyświetlaną użytkownika. Przydatne do rozróżnienia czy nazwa wyświetlana jest taka sama jak ID użytkownika
count – Liczba wyników do pobrania na stronę
cursor – Dzieli wyniki na strony. Ustaw wartość jako -1 by rozpocząć stronnicowanie. Dostarcz wartości tak jak są zwracane w tekście opowiedzi. Atrybuty next_cursor i previous_cursor używane są do przechoznenia na przód i w tył
- Zwraca
- Typ zwracany
List
[List
]
References
- API.create_list(name, *, mode, description)¶
Tworzy nową listę dla zuwierzytelnionego użytkownia. Miej na uwadzę, że możesz stworzyć maksymalnie 1000 list dla jednego konta.
- Parametry
name – Nazwa nowej listy.
mode – Czy lista jest publiczna czy prywatna. Wartości mogą być publiczne i prwyatne. Domyślnie listy są publiczne jeżeli nie jest ustawiony żaden tryb
description – Opis listy, którą tworzysz.
- Zwraca
- Typ zwracany
References
- API.destroy_list(*, owner_screen_name, owner_id, list_id, slug)¶
Usuwa określoną listę. Zuwierzytelniony użytkownik musi być właścicielem listy by ją usunąć.
- Parametry
owner_screen_name – Nazwa wyświetlana użytkownika, który jest właścicielem listy żądanej przez slug
owner_id – ID użytkownika, który jest właścicielem listy żadanej przez slug
list_id – Numeryczna lista ID
slug – Możesz zidentyfikować listę używając jej slug zamiast numerycznego ID. Jeżeli się na to zdecydujesz to będziesz musiał określić właściciela listy używając parametrów owner_id lub owner_screen_name
- Zwraca
- Typ zwracany
References
- API.add_list_member(*, list_id, slug, user_id, screen_name, owner_screen_name, owner_id)¶
Dodaje nowego członka do listy. Zuwierzytelniony użytkownik musi być właścicielem listy by dodawać do niej członków. Lista może zawierać maksymalnie 5000 członków.
- Parametry
list_id – Numeryczna lista ID
slug – Możesz zidentyfikować listę używając jej slug zamiast numerycznego ID. Jeżeli się na to zdecydujesz to będziesz musiał określić właściciela listy używając parametrów owner_id lub owner_screen_name
user_id – Określa ID użytkownika. Przydatne do rozróżnienia czy nazwa wyświetlana jest taka sama jak ID użytkownika
screen_name – Określa nazwę wyświetlaną użytkownika. Przydatne do rozróżnienia czy nazwa wyświetlana jest taka sama jak ID użytkownika
owner_screen_name – Nazwa wyświetlana użytkownika, który jest właścicielem listy żądanej przez slug
owner_id – ID użytkownika, który jest właścicielem listy żadanej przez slug
- Zwraca
- Typ zwracany
References
- API.add_list_members(*, list_id, slug, user_id, screen_name, owner_screen_name, owner_id)¶
Dodaje członków do listy, maksymalnie 100. Zuwierzytelniony użytkownik musi być właścicielem listy by dodawać do niej członków. Lista może zawierać maksymalnie 5000 członków.
- Parametry
list_id – Numeryczna lista ID
slug – Możesz zidentyfikować listę używając jej slug zamiast numerycznego ID. Jeżeli się na to zdecydujesz to będziesz musiał określić właściciela listy używając parametrów owner_id lub owner_screen_name
user_id – Oddzielona przecinkami lista ID użytkowników, maksymalnie 100 na jedno żądanie
screen_name – Oddzielona przecinkami lista nazw, maksymalnie 100 na jedno żądanie
owner_screen_name – Nazwa wyświetlana użytkownika, który jest właścicielem listy żądanej przez slug
owner_id – ID użytkownika, który jest właścicielem listy żadanej przez slug
- Zwraca
- Typ zwracany
References
- API.remove_list_member(*, list_id, slug, user_id, screen_name, owner_screen_name, owner_id)¶
Usuwa wybranego użytkownika z listy. Zuwierzytelniony użytkownik musi być właścicielem listy by usuwać z niej użytkowników.
- Parametry
list_id – Numeryczna lista ID
slug – Możesz zidentyfikować listę używając jej slug zamiast numerycznego ID. Jeżeli się na to zdecydujesz to będziesz musiał określić właściciela listy używając parametrów owner_id lub owner_screen_name
user_id – Określa ID użytkownika. Przydatne do rozróżnienia czy nazwa wyświetlana jest taka sama jak ID użytkownika
screen_name – Określa nazwę wyświetlaną użytkownika. Przydatne do rozróżnienia czy nazwa wyświetlana jest taka sama jak ID użytkownika
owner_screen_name – Nazwa wyświetlana użytkownika, który jest właścicielem listy żądanej przez slug
owner_id – ID użytkownika, który jest właścicielem listy żadanej przez slug
- Zwraca
- Typ zwracany
References
- API.remove_list_members(*, list_id, slug, user_id, screen_name, owner_screen_name, owner_id)¶
Usuwa użytkowników z listy, maksymalnie 100. Zuwierzytelniony użytkownik musi być właścicielem listy by usuwać z niej użytkowników. Listy mogą zawierać maksymalnie 5000 użytkowników.
- Parametry
list_id – Numeryczna lista ID
slug – Możesz zidentyfikować listę używając jej slug zamiast numerycznego ID. Jeżeli się na to zdecydujesz to będziesz musiał określić właściciela listy używając parametrów owner_id lub owner_screen_name
user_id – Oddzielona przecinkami lista ID użytkowników, maksymalnie 100 na jedno żądanie
screen_name – Oddzielona przecinkami lista nazw, maksymalnie 100 na jedno żądanie
owner_screen_name – Nazwa wyświetlana użytkownika, który jest właścicielem listy żądanej przez slug
owner_id – ID użytkownika, który jest właścicielem listy żadanej przez slug
- Zwraca
- Typ zwracany
References
- API.subscribe_list(*, owner_screen_name, owner_id, list_id, slug)¶
Subskrybuje zuwierzytelnionego użytkownika do określonej listy.
- Parametry
owner_screen_name – Nazwa wyświetlana użytkownika, który jest właścicielem listy żądanej przez slug
owner_id – ID użytkownika, który jest właścicielem listy żadanej przez slug
list_id – Numeryczna lista ID
slug – Możesz zidentyfikować listę używając jej slug zamiast numerycznego ID. Jeżeli się na to zdecydujesz to będziesz musiał określić właściciela listy używając parametrów owner_id lub owner_screen_name
- Zwraca
- Typ zwracany
References
- API.unsubscribe_list(*, list_id, slug, owner_screen_name, owner_id)¶
Anuluje subskrypcję zuwierzytelnionego użytkownika do określonej listy.
- Parametry
list_id – Numeryczna lista ID
slug – Możesz zidentyfikować listę używając jej slug zamiast numerycznego ID. Jeżeli się na to zdecydujesz to będziesz musiał określić właściciela listy używając parametrów owner_id lub owner_screen_name
owner_screen_name – Nazwa wyświetlana użytkownika, który jest właścicielem listy żądanej przez slug
owner_id – ID użytkownika, który jest właścicielem listy żadanej przez slug
- Zwraca
- Typ zwracany
References
- API.update_list(*, list_id, slug, name, mode, description, owner_screen_name, owner_id)¶
Aktualizuje wybraną listę. Zuwierzytelniony użytkownik musi być właścicielem listy by ją zaktualizować.
- Parametry
list_id – Numeryczna lista ID
slug – Możesz zidentyfikować listę używając jej slug zamiast numerycznego ID. Jeżeli się na to zdecydujesz to będziesz musiał określić właściciela listy używając parametrów owner_id lub owner_screen_name
name – Nazwa listy.
mode – Czy lista jest publiczna czy prywatna. Wartości mogą być publiczne i prwyatne. Domyślnie listy są publiczne jeżeli nie jest ustawiony żaden tryb
description – Opis nadany liście.
owner_screen_name – Nazwa wyświetlana użytkownika, który jest właścicielem listy żądanej przez slug
owner_id – ID użytkownika, który jest właścicielem listy żadanej przez slug
- Zwraca
- Typ zwracany
References
Słedzenie, wyszukiwanie i zdobywanie użytkowników¶
- API.get_follower_ids(*, user_id, screen_name, cursor, stringify_ids, count)¶
Zwraca tablicę zawierającą ID użytkowników obserwujących wybranego użytkownika.
- Parametry
user_id – Określa ID użytkownika. Przydatne do rozróżnienia czy nazwa wyświetlana jest taka sama jak ID użytkownika
screen_name – Określa nazwę wyświetlaną użytkownika. Przydatne do rozróżnienia czy nazwa wyświetlana jest taka sama jak ID użytkownika
cursor – Dzieli wyniki na strony. Ustaw wartość jako -1 by rozpocząć stronnicowanie. Dostarcz wartości tak jak są zwracane w tekście opowiedzi. Atrybuty next_cursor i previous_cursor używane są do przechoznenia na przód i w tył
stringify_ids – Zwraca tylko statusy z ID większym (tzn. nowszym) niż określone ID
count – Liczba wyników do pobrania na stronę
- Zwraca
- Typ zwracany
List
[int
]
References
- API.get_followers(*, user_id, screen_name, cursor, count, skip_status, include_user_entities)¶
Zwraca obserwujących użytkownika według chronologii rozpoczęcia przez nich obserwowania. Jeżeli użytkownik nie jest określony to domyślnie będzie użyty zuwierzytelniony użytkownik.
- Parametry
user_id – Określa ID użytkownika. Przydatne do rozróżnienia czy nazwa wyświetlana jest taka sama jak ID użytkownika
screen_name – Określa nazwę wyświetlaną użytkownika. Przydatne do rozróżnienia czy nazwa wyświetlana jest taka sama jak ID użytkownika
cursor – Dzieli wyniki na strony. Ustaw wartość jako -1 by rozpocząć stronnicowanie. Dostarcz wartości tak jak są zwracane w tekście opowiedzi. Atrybuty next_cursor i previous_cursor używane są do przechoznenia na przód i w tył
count – Liczba wyników do pobrania na stronę
skip_status – Boolean wskazujący czy będą zawarte w zwróconych obiektach user. Domyślnie False
include_user_entities – Gdy ustawione jako False to jednostki węzła obiektu user nie będą zawarte. Domyślnie True
- Zwraca
- Typ zwracany
List
[User
]
References
- API.get_friend_ids(*, user_id, screen_name, cursor, stringify_ids, count)¶
Zwraca tablicę zawierającą ID użytkowników obserwowanych przez wybranego użytkownika.
- Parametry
user_id – Określa ID użytkownika. Przydatne do rozróżnienia czy nazwa wyświetlana jest taka sama jak ID użytkownika
screen_name – Określa nazwę wyświetlaną użytkownika. Przydatne do rozróżnienia czy nazwa wyświetlana jest taka sama jak ID użytkownika
cursor – Dzieli wyniki na strony. Ustaw wartość jako -1 by rozpocząć stronnicowanie. Dostarcz wartości tak jak są zwracane w tekście opowiedzi. Atrybuty next_cursor i previous_cursor używane są do przechoznenia na przód i w tył
stringify_ids – Zwraca tylko statusy z ID większym (tzn. nowszym) niż określone ID
count – Liczba wyników do pobrania na stronę
- Zwraca
- Typ zwracany
List
[int
]
References
- API.get_friends(*, user_id, screen_name, cursor, count, skip_status, include_user_entities)¶
Zwraca znajomych użytkownika, 100 na raz, posortowanych według chronologii dodania do znajomych. Jeżeli użytkownik nie jest określony to domyślnie będzie użyty zuwierzytelniony użytkownik.
- Parametry
user_id – Określa ID użytkownika. Przydatne do rozróżnienia czy nazwa wyświetlana jest taka sama jak ID użytkownika
screen_name – Określa nazwę wyświetlaną użytkownika. Przydatne do rozróżnienia czy nazwa wyświetlana jest taka sama jak ID użytkownika
cursor – Dzieli wyniki na strony. Ustaw wartość jako -1 by rozpocząć stronnicowanie. Dostarcz wartości tak jak są zwracane w tekście opowiedzi. Atrybuty next_cursor i previous_cursor używane są do przechoznenia na przód i w tył
count – Liczba wyników do pobrania na stronę
skip_status – Boolean wskazujący czy będą zawarte w zwróconych obiektach user. Domyślnie False
include_user_entities – Gdy ustawione jako False to jednostki węzła obiektu user nie będą zawarte. Domyślnie True
- Zwraca
- Typ zwracany
List
[User
]
References
- API.incoming_friendships(*, cursor, stringify_ids)¶
Zwraca kolekcję numerycznych ID dla każdego użytkownika, któy ma oczekujący request follow zuwierzytelnionego użytkownika.
- Parametry
cursor – Dzieli wyniki na strony. Ustaw wartość jako -1 by rozpocząć stronnicowanie. Dostarcz wartości tak jak są zwracane w tekście opowiedzi. Atrybuty next_cursor i previous_cursor używane są do przechoznenia na przód i w tył
stringify_ids – Zwraca tylko statusy z ID większym (tzn. nowszym) niż określone ID
- Zwraca
- Typ zwracany
List
[int
]
References
- API.lookup_friendships(*, screen_name, user_id)¶
Zwraca relacje pomiędzy zuwierzytelnionym użytkownikiem a (maksimum) 100 dostarczonych screen_name oraz user_id.
- Parametry
screen_name – Lista nazw wyświetlanych, masymalnie 100 może być zawartych w pojedyńczym żądaniu.
user_id – Lista ID użytkowników, masymalnie 100 może być zawartych w pojedyńczym żądaniu.
- Zwraca
- Typ zwracany
List
[Relationship
]
References
- API.no_retweets_friendships(*, stringify_ids)¶
Zwraca kolekcję user_id od których zuwierzytelniony użytkownik nie chce otrzymywać retweetów.
- Parametry
stringify_ids – Zwraca tylko statusy z ID większym (tzn. nowszym) niż określone ID
- Zwraca
- Typ zwracany
List
[int
]
References
- API.outgoing_friendships(*, cursor, stringify_ids)¶
Zwraca zbiór numerycznych identyfikatorów każdego chronionego użytkownika, dla którego użytkownik uwierzytelniający ma oczekujące żądanie follow.
- Parametry
cursor – Dzieli wyniki na strony. Ustaw wartość jako -1 by rozpocząć stronnicowanie. Dostarcz wartości tak jak są zwracane w tekście opowiedzi. Atrybuty next_cursor i previous_cursor używane są do przechoznenia na przód i w tył
stringify_ids – Zwraca tylko statusy z ID większym (tzn. nowszym) niż określone ID
- Zwraca
- Typ zwracany
List
[int
]
References
- API.get_friendship(*, source_id, source_screen_name, target_id, target_screen_name)¶
Zwraca szczegółowe informacje na temat znajomości pomiędzy dwoma użytkownikami.
- Parametry
source_id – Wartość user_id podanego użytkownika.
source_screen_name – Wartość screen_name podanego użytkownika.
target_id – Wartość user_id wybranego użytkownika.
target_screen_name – Wartość screen_name wybranego użytkownika.
- Zwraca
- Typ zwracany
References
- API.lookup_users(*, screen_name, user_id, include_entities, tweet_mode)¶
Zwraca fully-hydrated obiekt użytkownika, maksymalnie 100 użytkowników na jedno żądanie.
Należy mieć na uwadze kilka kwestii używając tej metody.
Musisz obserwować chronionego użytkownika by móc zobaczyć jego najnowszą zmianę statusu. Jeżeli nie obserwujesz go, to jego status zostanie usunięty.
Porządek ID użytkowników lub nazw wyświetlanych może nie być rownoważny z porządkiem użytkowników w zwróconej tablicy.
Jeżeli żądany użytkownik jest nieznany, zablokowany lub usunięty to nie zostanie on zwrócony w liście wyników.
Jeżeli żadne z twoich wyszukiwań nie spełnia wymagań i nie zwraca obiektu użytkownika, to wystąpi błąd HTTP 404.
- Parametry
screen_name – Lista nazw wyświetlanych, masymalnie 100 może być zawartych w pojedyńczym żądaniu.
user_id – Lista ID użytkowników, masymalnie 100 może być zawartych w pojedyńczym żądaniu.
include_entities – Ustawione jako false powoduje, że węzeł jednostek nie będzie zawarty. Domyślnie False
tweet_mode – Poprawne wartości żądań są kompatybilne i rozszerzone, co nadaje im odpowiednio tryb kompatybilności lub trybowi rozszerzony, dla tweetów zawierających ponad 140 znaków.
- Zwraca
- Typ zwracany
List
[User
]
References
- API.search_users(q, *, page, count, include_entities)¶
Uruchom wyszukiwanie dla użytkowników podobne do przycisku Znajdź Ludzi na Twitter.com; używając teego API zostaną zwrócone te same rezultaty co w przypadku wyszukiwania ludzi. Używając tego API możliwe jest uzyskanie makymalnie 1000 pierwszych wyników.
- Parametry
q – Zapytanie, które jest uruchomione przeciwko wyszukiwaniom ludzi.
page – Określa którą stronę wyników otrzymać. Uwaga: istnieją limity stronnicowania
count – Liczba wyników do pobrania na stronę
include_entities – Ustawione jako false powoduje, że węzeł jednostek nie będzie zawarty. Domyślnie False
- Zwraca
- Typ zwracany
List
[User
]
References
- API.get_user(*, user_id, screen_name, include_entities)¶
Zwraca informacje o wybranym użytkowniku.
- Parametry
user_id – Określa ID użytkownika. Przydatne do rozróżnienia czy nazwa wyświetlana jest taka sama jak ID użytkownika
screen_name – Określa nazwę wyświetlaną użytkownika. Przydatne do rozróżnienia czy nazwa wyświetlana jest taka sama jak ID użytkownika
include_entities – Ustawione jako false powoduje, że węzeł jednostek nie będzie zawarty. Domyślnie False
- Zwraca
- Typ zwracany
References
- API.create_friendship(*, screen_name, user_id, follow)¶
Stwórz nową znajomość z wybranym użytkownikiem (obserwuj).
- Parametry
screen_name – Określa nazwę wyświetlaną użytkownika. Przydatne do rozróżnienia czy nazwa wyświetlana jest taka sama jak ID użytkownika
user_id – Określa ID użytkownika. Przydatne do rozróżnienia czy nazwa wyświetlana jest taka sama jak ID użytkownika
follow – Włącz notyfikacje dla wybranego użytkownika wraz z dodaniem go do znajomych.
- Zwraca
- Typ zwracany
References
- API.destroy_friendship(*, screen_name, user_id)¶
Zerwij znajomość z wybranym użytkownikim (przestań obserwować).
- Parametry
screen_name – Określa nazwę wyświetlaną użytkownika. Przydatne do rozróżnienia czy nazwa wyświetlana jest taka sama jak ID użytkownika
user_id – Określa ID użytkownika. Przydatne do rozróżnienia czy nazwa wyświetlana jest taka sama jak ID użytkownika
- Zwraca
- Typ zwracany
References
- API.update_friendship(*, screen_name, user_id, device, retweets)¶
Włącz/wyłącz Retweey i notyfikacje na urzędzeniach od wyznaczonego użytkownika.
- Parametry
screen_name – Określa nazwę wyświetlaną użytkownika. Przydatne do rozróżnienia czy nazwa wyświetlana jest taka sama jak ID użytkownika
user_id – Określa ID użytkownika. Przydatne do rozróżnienia czy nazwa wyświetlana jest taka sama jak ID użytkownika
device – Włącz/wyłacz notyfikacje na urządzeniach od wybranego użytkownika.
retweets – Włącz/wyłącz Retweety wybranego użytkownika.
- Zwraca
- Typ zwracany
References
Zarządzaj ustawieniami konta i profilu¶
- API.get_settings()¶
Zwraca ustawienia (w tym aktualny trend, geo oraz informacje o czasie uśpienia) dla zuwierzytelnionego użytkownika.
- Zwraca
JSON
- Typ zwracany
References
- API.verify_credentials(*, include_entities, skip_status, include_email)¶
Potwierdza, że dane podanego użytkownika są prawidłowe.
- Parametry
include_entities – Ustawione jako false powoduje, że węzeł jednostek nie będzie zawarty. Domyślnie False
skip_status – Boolean wskazujący czy będą zawarte w zwróconych obiektach user. Domyślnie False
include_email – Gdy ustawione jako true, e-mail będzie zwrócony w obiekcie użytkownika jako ciąg znaków.
- Wyrzuca
Unauthorized – Authentication unsuccessful
- Zwraca
- Typ zwracany
References
- API.get_saved_searches()¶
Zwraca zapisane zapytania zuwierzytelnionego użytkownika.
- Zwraca
- Typ zwracany
List
[SavedSearch
]
References
- API.get_saved_search(id)¶
Pobiera dane dla zapisanych wyszukiwań należących do zuwierzytelnionego użytkownika, określone przez podane ID.
- Parametry
id – ID zapisanego wyszukania które ma zostać pobrane.
- Zwraca
- Typ zwracany
References
- API.get_profile_banner(*, user_id, screen_name)¶
Zwraca mapę dostępnych wariantów rozmiaru banera profilowego określonego użytkownika. Jeśli użytkownik nie przesłał baneru profilowego, zamiast tego zostanie wyświetlony komunikat HTTP 404.
Dane banerów profilowych dostępne pod adresem URL każdego wariantu wielkościowego, w formacie PNG.
- Parametry
user_id – Określa ID użytkownika. Przydatne do rozróżnienia czy nazwa wyświetlana jest taka sama jak ID użytkownika
screen_name – Określa nazwę wyświetlaną użytkownika. Przydatne do rozróżnienia czy nazwa wyświetlana jest taka sama jak ID użytkownika
- Zwraca
JSON
- Typ zwracany
References
- API.remove_profile_banner()¶
Usuwa baner profilowy zuwierzytelnionego użytkownika.
References
- API.set_settings(*, sleep_time_enabled, start_sleep_time, end_sleep_time, time_zone, trend_location_woeid, lang)¶
Aktualizuje ustawienia zuwierzytelnionego użytkownika.
- Parametry
sleep_time_enabled – Gdy ustawione na
true
,t
lub1
, włączy czas uśpienia dla użytkownika. Czas uśpienia to czas, w którym powiadomienia push lub SMS nie powinny być wysyłane do użytkownika.start_sleep_time – Godzina, o której powinien rozpocząć się czas uśpienia, jeśli jest on włączony. Wartość dla tego parametru powinna być podana w formacie ISO 8601 (np. 00-23). Czas jest uważany za znajdujący się w tej samej strefie czasowej co ustawienie użytkownika
time_zone
.end_sleep_time – Godzina, o której powinien zakończyć się czas uśpienia, jeśli jest włączony. Wartość dla tego parametru powinna być podana w formacie ISO 8601 (np. 00-23). Czas jest uważany za znajdujący się w tej samej strefie czasowej co ustawienie użytkownika
time_zone
.time_zone – Strefa czasowa, w której powinny być wyświetlane daty i godziny dla użytkownika. Strefa czasowa musi być jedną z nazw Rails TimeZone.
trend_location_woeid – ID Yahoo! Where On Earth lokacji, dla której mają być zwrócone informacje o trendach. Globalne informacje są dostępne używając 1 jako WOEID.
lang – Język, w którym Twitter powinien renderować treści dla tego użytkownika. Język musi być określony przez odpowiednią dwuliterową reprezentację ISO 639-1.
- Zwraca
JSON
- Typ zwracany
References
- API.update_profile(*, name, url, location, description, profile_link_color, include_entities, skip_status)¶
Ustawia wartości, które użytkownicy mogą ustawić pod zakładką „Konto” w ustawieniach swojego konta.
- Parametry
name – Pełna nazwa powiązana z profilem.
url – Maximum 100 znaków. Będzie poprzedzone „http://” jeżeli jeszcze nie jest
location – Miasto lub kraj opisujący miejsce, w którym znajduje się użytkownik konta. Zawartość nie jest normalizowana ani geokodowana w żaden sposób.
description – Opis użytkownika, do którego należy konto.
profile_link_color – Ustawia wartość heksadecymalną, która kontroluje schemat kolorów linków używanych na stronie profilu zuwierzytelnionego użytkownika na twitter.com. Musi to być poprawna wartość szesnastkowa i może składać się z trzech lub sześciu znaków (np. F00 lub FF0000).
include_entities – Ustawione jako false powoduje, że węzeł jednostek nie będzie zawarty. Domyślnie False
skip_status – Boolean wskazujący czy będą zawarte w zwróconych obiektach user. Domyślnie False
- Zwraca
- Typ zwracany
References
- API.update_profile_banner(filename, *, file, width, height, offset_left, offset_top)¶
Zwraca tablicę obiektów użytkownika, którego wyciszył zuwierzytelniony użytkownik.
- Parametry
filename – Określa nazwę wyświetlaną użytkownika. Przydatne do rozróżnienia czy nazwa wyświetlana jest taka sama jak ID użytkownika
file – Lista ID tweetów do wyszukania, maksymalnie 100
width – Szerokość preferowanej części wysyłanego obrazu w pikselach. Użyj wraz z
height
,offset_left
, orazoffset_top
aby wybrać pożądany region obrazu do użycia.height – Wysokość preferowanej części wysyłanego obrazu w pikselach. Użyj wraz z
width
,offset_left
, ioffset_top
aby wybrać pożądany region obrazu do użycia.offset_left – Liczba pikseli, o którą ma być przesunięty przesłany obraz od lewej strony. Użyj razem z
height
,width
, ioffset_top
aby wybrać żądany region obrazu do użycia.offset_top – Liczba pikseli, o którą ma być przesunięty przesłany obraz od góry. Użyj razem z
height
,width
, ioffset_top
aby wybrać żądany region obrazu do użycia.
References
- API.update_profile_image(filename, *, file, include_entities, skip_status)¶
Aktualizuje zdjęcie profilowe zuwierzytelnionego użytkownika. Poprawne formaty: GIF, JPG oraz PNG
- Parametry
filename – Określa nazwę wyświetlaną użytkownika. Przydatne do rozróżnienia czy nazwa wyświetlana jest taka sama jak ID użytkownika
file – Lista ID tweetów do wyszukania, maksymalnie 100
include_entities – Ustawione jako false powoduje, że węzeł jednostek nie będzie zawarty. Domyślnie False
skip_status – Boolean wskazujący czy będą zawarte w zwróconych obiektach user. Domyślnie False
- Zwraca
- Typ zwracany
References
- API.create_saved_search(query)¶
Tworzy zapisane wyszukani dla zuwierzytelnionego użytkownika.
- Parametry
query – Zapytanie dla wyszukania, które użytkownik chciałby zapisać.
- Zwraca
- Typ zwracany
References
- API.destroy_saved_search(id)¶
Niszczy zapisane wyszukanie dla zuwierzytelnionego użytkownika. Wyszukanie określone przez ID musi należeć do zuwierzytelnionego użytkownika.
- Parametry
id – Parametr ID zapisanego wyszukania które ma zostać usunięte.
- Zwraca
- Typ zwracany
References
Wyciszanie, blokowanie i reportowanie użytkowników¶
- API.get_blocked_ids(*, stringify_ids, cursor)¶
Zwraca tablicę numerycznych ID użytkowników, którzy blokowani są przez zuwierzytelnionego użytkownika.
- Parametry
stringify_ids – Zwraca tylko statusy z ID większym (tzn. nowszym) niż określone ID
cursor – Dzieli wyniki na strony. Ustaw wartość jako -1 by rozpocząć stronnicowanie. Dostarcz wartości tak jak są zwracane w tekście opowiedzi. Atrybuty next_cursor i previous_cursor używane są do przechoznenia na przód i w tył
- Zwraca
- Typ zwracany
List
[int
]
References
- API.get_blocks(*, include_entities, skip_status, cursor)¶
Zwraca tablicę obiektów użytkownika, który blokowany jest przez zuwierzytelnionego użytkownika.
- Parametry
include_entities – Ustawione jako false powoduje, że węzeł jednostek nie będzie zawarty. Domyślnie False
skip_status – Boolean wskazujący czy będą zawarte w zwróconych obiektach user. Domyślnie False
cursor – Dzieli wyniki na strony. Ustaw wartość jako -1 by rozpocząć stronnicowanie. Dostarcz wartości tak jak są zwracane w tekście opowiedzi. Atrybuty next_cursor i previous_cursor używane są do przechoznenia na przód i w tył
- Zwraca
- Typ zwracany
List
[User
]
References
- API.get_muted_ids(*, stringify_ids, cursor)¶
Zwraca tablicę numerycznych ID użytkowników, których wyciszył zuwierzytelniony użytkownik.
- Parametry
stringify_ids – Zwraca tylko statusy z ID większym (tzn. nowszym) niż określone ID
cursor – Dzieli wyniki na strony. Ustaw wartość jako -1 by rozpocząć stronnicowanie. Dostarcz wartości tak jak są zwracane w tekście opowiedzi. Atrybuty next_cursor i previous_cursor używane są do przechoznenia na przód i w tył
- Zwraca
- Typ zwracany
List
[int
]
References
- API.get_mutes(*, cursor, include_entities, skip_status)¶
Zwraca tablicę obiektów użytkownika, którego wyciszył zuwierzytelniony użytkownik.
- Parametry
cursor – Dzieli wyniki na strony. Ustaw wartość jako -1 by rozpocząć stronnicowanie. Dostarcz wartości tak jak są zwracane w tekście opowiedzi. Atrybuty next_cursor i previous_cursor używane są do przechoznenia na przód i w tył
include_entities – Ustawione jako false powoduje, że węzeł jednostek nie będzie zawarty. Domyślnie False
skip_status – Boolean wskazujący czy będą zawarte w zwróconych obiektach user. Domyślnie False
- Zwraca
- Typ zwracany
List
[User
]
References
- API.create_block(*, screen_name, user_id, include_entities, skip_status)¶
Blokuje określonemu użytkownikowi możliwość śledzenia zuwierzytelnionego użytkownika. Dodatkowo zablokowany użytkownik nie będzie widoczny we wzmiankach ani na osi czasu zuwierzytelnionego użytkownika (chyba, że jest retweetowany przez innego użytkownika). Jeśli istnieje relacja follow lub znajomy, zostaje ona zniszczona.
- Parametry
screen_name – Określa nazwę wyświetlaną użytkownika. Przydatne do rozróżnienia czy nazwa wyświetlana jest taka sama jak ID użytkownika
user_id – Określa ID użytkownika. Przydatne do rozróżnienia czy nazwa wyświetlana jest taka sama jak ID użytkownika
include_entities – Ustawione jako false powoduje, że węzeł jednostek nie będzie zawarty. Domyślnie False
skip_status – Boolean wskazujący czy będą zawarte w zwróconych obiektach user. Domyślnie False
- Zwraca
- Typ zwracany
References
- API.destroy_block(*, screen_name, user_id, include_entities, skip_status)¶
Odblokowywuje użytkownika określonego przez parametr ID jako zuwierzytelniony użytkownik.
- Parametry
screen_name – Określa nazwę wyświetlaną użytkownika. Przydatne do rozróżnienia czy nazwa wyświetlana jest taka sama jak ID użytkownika
user_id – Określa ID użytkownika. Przydatne do rozróżnienia czy nazwa wyświetlana jest taka sama jak ID użytkownika
include_entities – Ustawione jako false powoduje, że węzeł jednostek nie będzie zawarty. Domyślnie False
skip_status – Boolean wskazujący czy będą zawarte w zwróconych obiektach user. Domyślnie False
- Zwraca
- Typ zwracany
References
- API.create_mute(*, screen_name, user_id)¶
Wycisza użytkownika określonego przez parametr ID dla zuwierzytelnionego użytkownika.
- Parametry
screen_name – Określa nazwę wyświetlaną użytkownika. Przydatne do rozróżnienia czy nazwa wyświetlana jest taka sama jak ID użytkownika
user_id – Określa ID użytkownika. Przydatne do rozróżnienia czy nazwa wyświetlana jest taka sama jak ID użytkownika
- Zwraca
- Typ zwracany
References
- API.destroy_mute(*, screen_name, user_id)¶
Wyłącza wyciszenie użytkownika określonego przez parametr ID dla zuwierzytelnionego użytkownika.
- Parametry
screen_name – Określa nazwę wyświetlaną użytkownika. Przydatne do rozróżnienia czy nazwa wyświetlana jest taka sama jak ID użytkownika
user_id – Określa ID użytkownika. Przydatne do rozróżnienia czy nazwa wyświetlana jest taka sama jak ID użytkownika
- Zwraca
- Typ zwracany
References
- API.report_spam(*, screen_name, user_id, perform_block)¶
Zreportuj do Twittera wyznaczonego użytkownika jako spamera.
- Parametry
screen_name – Określa nazwę wyświetlaną użytkownika. Przydatne do rozróżnienia czy nazwa wyświetlana jest taka sama jak ID użytkownika
user_id – Określa ID użytkownika. Przydatne do rozróżnienia czy nazwa wyświetlana jest taka sama jak ID użytkownika
perform_block – Boolean wskazujący czy zgłoszone konto ma być zablokowane. Domyślnie true.
- Zwraca
- Typ zwracany
References
Wiadomości Bezpośrednie¶
Wysyłanie i otrzymywanie zdarzeń¶
- API.delete_direct_message(id)¶
Usuwa wiadomość bezpośrednią określona w wymaganym parametrze ID. Zuwierzytelniony użytkownik musi być odbiorcą tej konkretnej wiadomości bezpośredniej. Wiadomości bezpośrednie mogą być usunięte tylko z intefejsu dostarczonego kontektu użytkownika. Inni członkowie konwersacji nadal mają dostęp do Wiadomości Bezpośrednich.
- Parametry
id – Parametr ID Wiadomości Bezpośredniej która ma zostać usunięta.
References
- API.get_direct_messages(*, count, cursor)¶
Zwraca wszystkie zdarzenia Wiadomości Bezpośrednich (otrzymane i wysłane) w ostatnich 30 dniach. Posortowane w odwrotnym porządku chronologicznym.
- Parametry
count – Liczba wyników do pobrania na stronę
cursor – Dzieli wyniki na strony. Ustaw wartość jako -1 by rozpocząć stronnicowanie. Dostarcz wartości tak jak są zwracane w tekście opowiedzi. Atrybuty next_cursor i previous_cursor używane są do przechoznenia na przód i w tył
- Zwraca
- Typ zwracany
List
[DirectMessage
]
References
- API.get_direct_message(id)¶
Zwraca wybraną wiadomość bezpośrednią.
- Parametry
id – Parametr ID Wiadomości Bezpośredniej która ma zostać usunięta.
- Zwraca
- Typ zwracany
References
- API.send_direct_message(recipient_id, text, *, quick_reply_options, attachment_type, attachment_media_id, ctas)¶
Wysyła nową wiadomość bezpośrednią od zuwierzytelniongo użytkownika do wybranego użytkownika.
- Parametry
recipient_id – ID użytkownika, który ma otrzymać wiadomość.
text – Tekst twojej Wiadomości Bezpośrednij. Maksymalna długość: 10000 znaków.
quick_reply_options – Tablica obiektów Opcji (maks 20).
attachment_type – Typ załącznika. Może być mediami lub lokacją.
attachment_media_id – ID mediów do powiązania z wiadomością. Wiadomość bezpośrednia może odnosić si tylko do pojedyńczeego media_id.
ctas – Tablica 1-3 obiektów przycisków call-to-action (CTA)
- Zwraca
- Typ zwracany
References
Media¶
Prześlij media¶
- API.get_media_upload_status(media_id)¶
Sprawdza postęp przesyłania mediów w postaci chunked. Jeśli przesyłanie zakończyło się sukcesem, można bezpiecznie utworzyć Tweeta z tym
media_id
.- Parametry
media_id – ID mediów do sprawdzenia.
- Zwraca
- Typ zwracany
References
- API.create_media_metadata(media_id, alt_text)¶
Ten punkt końcowy może być użyty do dostarczenia dodatkowych informacji na temat wrzuconego
media_id
. Ta funkcja na tę chwilę jest wspierana tylko przez obrazy i GIFy. Wywołaj ten punkt końcowy by dodać dodatkowe metadane takie jak alt text.- Parametry
media_id – ID mediów, do których dodany jest alt text.
alt_text – Alt tekst który zostanie dodany do obrazu.
References
- API.media_upload(filename, *, file, chunked, media_category, additional_owners)¶
Użyj tego, aby przesłać media na Twittera. Wywoływana jest albo
API.simple_upload()
lubAPI.chunked_upload()
. Przesyłanie mediów w postaci plików chunked jest automatycznie używane dla filmów. Jeślichunked
jest ustawione lub media są wideo,wait_for_async_finalize
może być określone jako argument słowa kluczowego, które ma być przekazane doAPI.chunked_upload()
.- Parametry
filename – Określa nazwę wyświetlaną użytkownika. Przydatne do rozróżnienia czy nazwa wyświetlana jest taka sama jak ID użytkownika
file – Lista ID tweetów do wyszukania, maksymalnie 100
chunked – Czy używać przesyłania mediów w postaci plików chunked czy nie. Filmy używają przesyłania w postaci plików chunked niezależnie od tego parametru. Domyślnie ustawione na
False
.media_category – Kategoria, która reprezentuje sposób, w jaki media będą używane. To pole jest wymagane podczas korzystania z mediów za pomocą Ads API
additional_owners – Lista identyfikatorów użytkowników do ustawienia jako dodatkowych właścicieli, którzy mogą używać zwróconego
media_id
w Tweetach lub Kartach. Można podać do 100 dodatkowych właścicieli.
- Zwraca
- Typ zwracany
References
https://developer.twitter.com/en/docs/twitter-api/v1/media/upload-media/overview
- API.simple_upload(filename, *, file, media_category, additional_owners)¶
Użyj tego punktu końcowego do przesyłania mediów do Twittera. Nie używane są punkty końcowe przesyłania chunked.
- Parametry
filename – Określa nazwę wyświetlaną użytkownika. Przydatne do rozróżnienia czy nazwa wyświetlana jest taka sama jak ID użytkownika
file – Lista ID tweetów do wyszukania, maksymalnie 100
media_category – Kategoria, która reprezentuje sposób, w jaki media będą używane. To pole jest wymagane podczas korzystania z mediów za pomocą Ads API
additional_owners – Lista identyfikatorów użytkowników do ustawienia jako dodatkowych właścicieli, którzy mogą używać zwróconego
media_id
w Tweetach lub Kartach. Można podać do 100 dodatkowych właścicieli.
- Zwraca
- Typ zwracany
References
- API.chunked_upload(filename, *, file, file_type, wait_for_async_finalize, media_category, additional_owners)¶
Użyj tego, aby przesłać media naTwittera. Użyte są punkty końcowye chunked upload i wywoływana
API.chunked_upload_init()
,API.chunked_upload_append()
, iAPI.chunked_upload_finalize()
. Jeśliwait_for_async_finalize
jest ustawione, wywołuje to równieżAPI.get_media_upload_status()
.- Parametry
filename – Określa nazwę wyświetlaną użytkownika. Przydatne do rozróżnienia czy nazwa wyświetlana jest taka sama jak ID użytkownika
file – Lista ID tweetów do wyszukania, maksymalnie 100
file_type – Typ MIME mediów, któa są przesyłane.
wait_for_async_finalize – Czy czekać czy nie., aż Twitter API zakończy procesowanie mediów. Domyślnie
True
.media_category – Kategoria, która reprezentuje sposób, w jaki media będą używane. To pole jest wymagane podczas korzystania z mediów za pomocą Ads API
additional_owners – Lista identyfikatorów użytkowników do ustawienia jako dodatkowych właścicieli, którzy mogą używać zwróconego
media_id
w Tweetach lub Kartach. Można podać do 100 dodatkowych właścicieli.
- Zwraca
- Typ zwracany
References
- API.chunked_upload_append(media_id, media, segment_index)¶
Użyj tego punktu końcowego by przesłać chunk (kolejny zakres bajtów) pliku media.
- Parametry
media_id – Parametr
media_id
zwrócony podczas inicjalizacji.media – Zawartość pliku, który jest przesyłany, w formie binarnej. Musi być <= 5 MB.
segment_index – Uporządkowany indeks kawałka pliku. Musi zawierać się w przedziale 0-999 włącznie. Pierwszy segment ma indeks 0, drugi segment ma indeks 1, i tak dalej.
References
- API.chunked_upload_finalize(media_id)¶
Użyj tego punktu końcowego po przesłaniu całego pliku media poprzez appending. Jeśli (i tylko jeśli) odpowiedź zawiera pole
processing_info
, może być również konieczne sprawdzenie jego statusu i poczekanie, aż zwróci status sukces przed przejściem do tworzenia Tweeta.- Parametry
media_id – Parametr
media_id
zwrócony podczas inicjalizacji.- Zwraca
- Typ zwracany
References
- API.chunked_upload_init(total_bytes, media_type, *, media_category, additional_owners)¶
Użyj tego punktu końcowego do zainicjowania sesji wysyłania plików w postaci chunked.
- Parametry
total_bytes – Rozmiar przesłanych mediów, wyrażony w bajtach.
media_type – Typ MIME mediów, któa są przesyłane.
media_category – Kategoria, która reprezentuje sposób, w jaki media będą używane. To pole jest wymagane podczas korzystania z mediów za pomocą Ads API
additional_owners – Lista identyfikatorów użytkowników do ustawienia jako dodatkowych właścicieli, którzy mogą używać zwróconego
media_id
w Tweetach lub Kartach. Można podać do 100 dodatkowych właścicieli.
- Zwraca
- Typ zwracany
References
Trendy¶
Uzyskaj lokacje z trendującymi tematami¶
- API.available_trends()¶
Zwraca lokację, dla której Twitter posiada informacje o trendujących tematach. Odpowiedź będzie w formie tablicy `”locations”, który szyfruje WOEID ( Yahoo! Where On Earth ID) lokacji i inne odczytywalne przez człowieka informacje takie jak autentyczna nazwa oraz państwo, w którym znajduje się lokacja.
- Zwraca
JSON
- Typ zwracany
References
- API.closest_trends(lat, long)¶
Zwraca lokację, dla której Twitter ma trendujące tematy najbardziej zbliżone do określonej lokacji.
Ta odpowiedź jest tablicą „locations” który szyfruje WOEID lokacji oraz inne odczytywalne przz człowieka informacje takie jak autentyczna nazwa oraz państwo w którym lokacja się znajduje.
WOEID jest to Yahoo! Where On Earth ID.
- Parametry
lat – Jeżeli podana jest długość gograficzna to dostępne trendy lokacji będa ustawione wg. dystansu od najbliższej do najdalszej, w parach co-ordinate. Poprawne wartości długośći gograficznej to wyłącznie wartości od -180.0 do +180.0 (zachód to wartość negatywna, wschód to pozytywna).
long – Jeżeli podana jest szerokość gograficzna to dostępne trendy lokacji będa ustawione wg. dystansu od najbliższej do najdalszej, w parach co-ordinate. Poprawne wartości długośći gograficznej to wyłącznie wartości od -180.0 do +180.0 (zachód to wartość negatywna, wschód to pozytywna).
- Zwraca
JSON
- Typ zwracany
References
Uzyskaj trendy w okolicy danej lokacji¶
- API.get_place_trends(id *, exclude)¶
Zwraca top 50 trendujących tematów dla wybranego WOEID jeżeli są dla nich dostępne informacje.
Ta odpowiedź jest tablicą obiektów „trend” które szyfrują nazwę trendującego tematu, parametr zapytania, który może być użyty do wyszukania tematu na Twitter Search a także Twitter Search URL.
Ta informacja zostaje zmagazynowana na 5 minut. Zażądanie większej częstotliwości nie zwróci większej ilości danych i nie będzie liczyć się jako wspólczynnik limitu używania.
Wartość tweet_volume dla ostatnich 24 godzin jest także zwracane dla wielu trendów jeżeli jest to możliwe.
- Parametry
id – ID Yahoo! Where On Earth lokacji, dla której mają być zwrócone informacje o trenach. Globalne informacje są dostępne używając 1 jako WOEID.
exclude – Ustawienie tego jako jednakowe z hashtagami, spowoduje usunięcie hashtagów z listy trendów.
- Zwraca
JSON
- Typ zwracany
References
Geo¶
Uzyskaj informacje na temat lokacji¶
- API.geo_id(place_id)¶
Posiadając
place_id
lokacji podaje więcej informacji na jej temat.- Parametry
place_id – Poprawny ID Twittera lokacji.
- Zwraca
- Typ zwracany
References
Uzyskaj miejsca w pobliżu danej lokacji¶
- API.reverse_geocode(lat, long, *, accuracy, granularity, max_results)¶
Biorąc pod uwagę szerokość i długość geograficzną, wyszukuje do 20 miejsc, które mogą być użyte jako
place_id
podczas aktualizacji statusu.To zapytanie ma charakter informacyjny i dostarczy uogólnionych wyników dotyczących danych geograficznych.
- Parametry
lat – Szerokość geograficzna lokacji.
long – Długość geograficzna lokacji.
accuracy – Określa „region” do wyszukiwania, między innymi numer (wtedy jest to zasięg w metrach, ale może być to też ciąg znaków zakończonych jako stopy). Jeżeli nie jest to przekazane, założony będzie zasięg 0m
granularity – Domyślnie przyjmuje się, że jest to
neighborhood'`; może być także ``city
.max_results – Wskazówka co do maksymalnej liczby rezultatów, które zostaną zwrócone. Jest to tylko wskazanie, nie musisz się do niego stosować.
- Zwraca
- Typ zwracany
List
[Place
]
References
- API.search_geo(*, lat, long, query, ip, granularity, max_results)¶
Wyszukuje miejsca, które mogą być dołączone do Tweeta poprzez
API.update_status()
. Biorąc pod uwagę parę szerokości i długości geograficznej, adres IP lub nazwę, to zapytanie zwróci listę wszystkich poprawnych miejsc, które mogą być użyte jakoplace_id
podczas aktualizacji statusu.W teorii, zapytanie może być wykonane z lokalizacji użytkownika, pobrać listę miejsc, oraz wymóc na użytkowniku zatwierdzenie lokalizacji, w której się znajduje, a następnie wysłać ID tej lokalizacji z wywołaniem
API.update_status()
.Jest to zalecana metoda do użycia w celu znalezienia miejsc, które mogą być dołączone do
API.update_status()
. W przeciwieństwie doAPI.reverse_geocode()
, który zapewnia dostęp do surowych danych, ten punkt końcowy może potencjalnie zmienić kolejność miejsc w odniesieniu do zuwierzytelnionego użytkownika. Ten sposó jest również preferowany dla interaktywnego dopasowywania miejsc z użytkownikiem.Niektóre parametry w tej metodzie są wymagane tylko na podstawie istnienia innych parametrów. Na przykład,
lat
jest wymagany jeślilong
jest podany i na odwrót.- Parametry
lat – Szerokość geograficzna lokacji do której odnosi się tweet. Ten parametr zostanie zignorowany, chyba, że znajduje się pomiędzy -90.0 a +90.0 (północ to wartość dodatnia). Zostanie on także zignorowany jeżeli nie ma on dopasowanego parametru
long
.long – Długość geograficzna do której odnosi się tweet. Poprawne wartości zawieraja się między -180.0 a +180.0 (wschód to wartość dodatnia). Ten parametr zostanie zignorowany jeżeli przekracza ten zakres, nie jest liczbą, gdy geo_enabled jest wyłączone oraz jeżeli nie ma dopasowanego parametru
lat
.query – Dowolny tekst do dopasowania podczas wykonywania zapytania opartego na geolokacji, najlepiej nadaje się do wyszukiwania pobliskich lokalizacji według nazwy.
ip – Adres IP. Używane przy próbie ustalenia geolokalizacji na podstawie adresu IP użytkownika.
granularity – Jest to minimalna wartość stopnia szczegółowości typów miejsc do zwrócenia i musi być jednym z:
neighborhood
,city
,admin
lubcountry
. Jeśli nie podano stopnia szczegółowości to ustawione jest ono jako``neighborhood``. Ustawienie tego nacity
, na przykład, znajdzie miejsca, które mają typcity
,admin
lubcountry
.max_results – Podpowiedź co do liczby wyników do zwrócenia. Nie gwarantuje to, że liczba zwróconych wyników będzie równa
max_results
, ale zamiast tego informuje ile „pobliskich” wyników zwrócić. Najlepiej określać należy tylko taką liczbę miejsc, jaką zamierzasz wyświetlić użytkownikowi.
- Zwraca
- Typ zwracany
List
[Place
]
References
Narzędzia developerskie¶
Uzyskaj języki obsługiwane przez Twittera¶
- API.supported_languages()¶
Zwraca listę języków obsługiwanych przez Twittera wraz z ich kodem.
Kod języka może być sformatowany jako ISO 639-1 alfa-2 (
en
), ISO 639-3 alfa-3 (msa
) lub ISO 639-1 alfa-2 w połączeniu z lokalizacją ISO 3166-1 alfa-2 (zh-tw
).- Zwraca
JSON
- Typ zwracany
References
Uzyskaj status limitu aplikacji¶
- API.rate_limit_status(*, resources)¶
Zwraca aktualne limity wartości dla metod należących do wybranej rodziny zasobów. Używając tego uwierzytelniania (tylko dla aplikacji), odpowiedź tej metody wskaże limit kontekstu dla tego uwierzytelniania.
- Parametry
resources – Odseparowana przecinkami lista rodziny zasobów. Powinieneś znać aktualny limit wartośći dyspozycji dla.
- Zwraca
JSON
- Typ zwracany
References
Przypisy