PostsClient

​

하위 모듈

• xdk.posts.client 모듈
  • PostsClient
    • PostsClient.__init__()
    • PostsClient.create()
    • PostsClient.delete()
    • PostsClient.get_analytics()
    • PostsClient.get_by_id()
    • PostsClient.get_by_ids()
    • PostsClient.get_counts_all()
    • PostsClient.get_counts_recent()
    • PostsClient.get_insights28hr()
    • PostsClient.get_insights_historical()
    • PostsClient.get_liking_users()
    • PostsClient.get_quoted()
    • PostsClient.get_reposted_by()
    • PostsClient.get_reposts()
    • PostsClient.hide_reply()
    • PostsClient.search_all()
    • PostsClient.search_recent()
• xdk.posts.models 모듈
  • CreateRequest
    • CreateRequest.model_config
  • CreateResponse
    • CreateResponse.model_config
  • DeleteResponse
    • DeleteResponse.model_config
  • GetAnalyticsResponse
    • GetAnalyticsResponse.model_config
  • GetByIdResponse
    • GetByIdResponse.model_config
  • GetByIdsResponse
    • GetByIdsResponse.model_config
  • GetCountsAllResponse
    • GetCountsAllResponse.model_config
  • GetCountsRecentResponse
    • GetCountsRecentResponse.model_config
  • GetInsights28hrResponse
    • GetInsights28hrResponse.model_config
  • GetInsightsHistoricalResponse
    • GetInsightsHistoricalResponse.model_config
  • GetLikingUsersResponse
    • GetLikingUsersResponse.model_config
  • GetQuotedResponse
    • GetQuotedResponse.model_config
  • GetRepostedByResponse
    • GetRepostedByResponse.model_config
  • GetRepostsResponse
    • GetRepostsResponse.model_config
  • HideReplyRequest
    • HideReplyRequest.model_config
  • HideReplyResponse
    • HideReplyResponse.model_config
  • SearchAllResponse
    • SearchAllResponse.model_config
  • SearchRecentResponse
    • SearchRecentResponse.model_config

​

모듈 내용

이 모듈은 X API의 Posts 엔드포인트에 대한 접근을 제공하며, 포스트 관련 모든 기능에 대한 주요 진입점 역할을 합니다.

​

class xdk.posts.PostsClient

포스트 작업용 Client

​

매개변수

path.client · Client

​

__init__

​

매개변수

path.client · Client

​

create

게시물 생성 또는 수정 인증된 사용자의 새 게시물을 생성하거나, edit_options가 제공된 경우 기존 게시물을 수정합니다. body: 요청 본문 :returns: 응답 데이터 :rtype: CreateResponse

​

매개변수

body.body · CreateRequest

​

delete

게시물 삭제 인증된 사용자가 소유한 경우, ID로 지정된 특정 게시물을 삭제합니다.

​

Parameters

path.id · Any

삭제할 게시물의 ID입니다.

​

반환

DeleteResponse - 반환 데이터

​

get_analytics

포스트 분석 가져오기 지정된 시간 범위 내 특정 포스트에 대한 분석 데이터를 조회합니다.

​

매개변수

path.ids · List

쉼표로 구분된 게시물 ID 리스트입니다. 한 요청당 최대 100개까지 허용됩니다.

path.end_time · str

YYYY-MM-DDTHH:mm:ssZ. 시간 범위의 종료 시점을 나타내는 UTC 타임스탬프입니다.

path.start_time · str

YYYY-MM-DDTHH:mm:ssZ. 시간 범위의 시작 시점을 나타내는 UTC 타임스탬프입니다.

path.granularity · str

검색 카운트 결과에 사용할 세분성(granularity)입니다.

path.analytics_fields · List or None · 기본값: "None"

표시할 Analytics 필드를 쉼표로 구분한 리스트입니다.

​

반환값

GetAnalyticsResponse - 응답 데이터

​

get_by_id

ID로 게시물 조회 특정 게시물의 ID를 사용해 해당 게시물의 세부 정보를 조회합니다.

​

매개변수

path.id · Any

단일 게시물 ID입니다.

path.tweet_fields · List or None · 기본값: "None"

표시할 Tweet 필드의 쉼표로 구분된 목록입니다.

path.expansions · List or None · 기본값: "None"

확장할 필드의 쉼표로 구분된 목록입니다.

path.media_fields · List or None · 기본값: "None"

표시할 Media 필드의 쉼표로 구분된 목록입니다.

path.poll_fields · List or None · 기본값: "None"

표시할 Poll 필드의 쉼표로 구분된 목록입니다.

path.user_fields · List or None · 기본값: "None"

표시할 User 필드의 쉼표로 구분된 목록입니다.

path.place_fields · List or None · 기본값: "None"

표시할 Place 필드의 쉼표로 구분된 목록입니다.

​

반환값

GetByIdResponse - 응답 데이터

​

get_by_ids

ID로 포스트 가져오기 여러 개의 포스트를 해당 ID로 조회합니다.

​

매개변수

path.ids · List

쉼표로 구분된 게시물 ID 목록입니다. 한 번의 요청에서 최대 100개까지 허용됩니다.

path.tweet_fields · List or None · 기본값: "None"

표시할 Tweet 필드의 쉼표로 구분된 목록입니다.

path.expansions · List or None · 기본값: "None"

확장할 필드의 쉼표로 구분된 목록입니다.

path.media_fields · List or None · 기본값: "None"

표시할 Media 필드의 쉼표로 구분된 목록입니다.

path.poll_fields · List or None · 기본값: "None"

표시할 Poll 필드의 쉼표로 구분된 목록입니다.

path.user_fields · List or None · 기본값: "None"

표시할 User 필드의 쉼표로 구분된 목록입니다.

path.place_fields · List or None · 기본값: "None"

표시할 Place 필드의 쉼표로 구분된 목록입니다.

​

반환값

GetByIdsResponse - 응답 데이터

​

get_counts_all

모든 포스트 개수 가져오기 전체 아카이브에서 검색 쿼리에 일치하는 포스트 개수를 가져옵니다.

​

Parameters

path.query · str

포스트와 일치시키기 위한 하나의 쿼리/규칙/필터입니다. 최대 쿼리 길이를 확인하려면 https://t.co/rulelength를 참고하세요.

path.start_time · str or None · 기본값: "None"

YYYY-MM-DDTHH:mm:ssZ. 포스트를 제공하기 시작하는 기준이 되는 가장 오래된 UTC 타임스탬프(가장 최근 7일 이내)입니다. 타임스탬프는 초 단위 정밀도를 가지며, 포함 범위입니다(예: 12:00:01은 해당 분의 첫 번째 초를 포함합니다).

path.end_time · str or None · 기본값: "None"

YYYY-MM-DDTHH:mm:ssZ. 포스트를 제공하는 기준이 되는 가장 최신 UTC 타임스탬프입니다. 타임스탬프는 초 단위 정밀도를 가지며, 제외 범위입니다(예: 12:00:01은 해당 분의 첫 번째 초를 제외합니다).

path.since_id · Any or None · 기본값: "None"

지정된 ID보다 큰(즉, 더 최신인) 게시물 ID를 가진 결과를 반환합니다.

path.until_id · Any or None · 기본값: "None"

지정된 ID보다 작은(즉, 더 오래된) 게시물 ID를 가진 결과를 반환합니다.

path.next_token · Any or None · 기본값: "None"

이 파라미터는 다음 페이지의 결과를 가져오는 데 사용됩니다. 이 파라미터에 사용되는 값은 API가 제공하는 응답에서 직접 가져오며, 수정해서는 안 됩니다.

path.pagination_token · Any or None · 기본값: "None"

이 파라미터는 다음 페이지의 결과를 가져오는 데 사용됩니다. 이 파라미터에 사용되는 값은 API가 제공하는 응답에서 직접 가져오며, 수정해서는 안 됩니다.

path.granularity · str or None · 기본값: "None"

검색 카운트 결과의 세분화 수준입니다.

path.search_count_fields · List or None · 기본값: "None"

표시할 SearchCount 필드의 쉼표로 구분된 리스트입니다.

​

반환값

IteratorGetCountsAllResponse

​

get_counts_recent

최근 포스트 수 가져오기 검색 쿼리와 일치하는 최근 7일간의 포스트 수를 조회합니다.

​

매개변수

path.query · str

게시물을 매칭하기 위한 하나의 쿼리/규칙/필터입니다. 최대 쿼리 길이를 확인하려면 https://t.co/rulelength을 참고하세요.

path.start_time · str or None · 기본값: "None"

YYYY-MM-DDTHH:mm:ssZ 형식입니다. 게시물이 제공될 가장 오래된 UTC 타임스탬프(최근 7일 이내)입니다. 타임스탬프는 초 단위이며, 포함입니다(예: 12:00:01은 해당 분의 첫 번째 초를 포함).

path.end_time · str or None · 기본값: "None"

YYYY-MM-DDTHH:mm:ssZ 형식입니다. 게시물이 제공될 가장 최신 UTC 타임스탬프입니다. 타임스탬프는 초 단위이며, 제외입니다(예: 12:00:01은 해당 분의 첫 번째 초를 제외).

path.since_id · Any or None · 기본값: "None"

지정된 ID보다 큰(즉, 더 최신인) 게시물 ID를 가진 결과를 반환합니다.

path.until_id · Any or None · 기본값: "None"

지정된 ID보다 작은(즉, 더 오래된) 게시물 ID를 가진 결과를 반환합니다.

path.next_token · Any or None · 기본값: "None"

다음 ‘페이지’의 결과를 가져오는 데 사용되는 파라미터입니다. 이 파라미터에 사용되는 값은 API가 반환한 응답에서 직접 가져오며, 수정해서는 안 됩니다.

path.pagination_token · Any or None · 기본값: "None"

다음 ‘페이지’의 결과를 가져오는 데 사용되는 파라미터입니다. 이 파라미터에 사용되는 값은 API가 반환한 응답에서 직접 가져오며, 수정해서는 안 됩니다.

path.granularity · str or None · 기본값: "None"

검색 카운트 결과의 세분화 수준을 지정합니다.

path.search_count_fields · List or None · 기본값: "None"

표시할 SearchCount 필드를 쉼표로 구분한 목록입니다.

​

반환값

IteratorGetCountsRecentResponse

​

get_insights28hr

28시간 포스트 인사이트 가져오기 지정된 포스트에 대한 참여 지표를 최근 28시간 동안 조회합니다.

​

매개변수

path.tweet_ids · List

28시간 메트릭에 대한 게시물 id 목록입니다.

path.granularity · str

메트릭 응답의 세분성입니다.

path.requested_metrics · List

과거 요청에 대해 조회할 메트릭 목록입니다.

path.engagement_fields · List or None · 기본값: "None"

표시할 Engagement 필드를 쉼표로 구분한 목록입니다.

​

반환 값

GetInsights28hrResponse - 응답 데이터

​

get_insights_historical

과거 게시물 인사이트 조회 지정된 게시물에 대해 정의된 시간 범위 내의 과거 참여 지표를 조회합니다.

​

매개변수

path.tweet_ids · List

과거 메트릭을 위한 게시물 id 목록입니다.

path.end_time · str

YYYY-MM-DDTHH:mm:ssZ. 시간 범위의 끝을 나타내는 UTC 타임스탬프입니다.

path.start_time · str

YYYY-MM-DDTHH:mm:ssZ. 시간 범위의 시작을 나타내는 UTC 타임스탬프입니다.

path.granularity · str

메트릭 응답의 세분화 수준입니다.

path.requested_metrics · List

과거 조회에 대해 요청할 메트릭 목록입니다.

path.engagement_fields · List or None · 기본값: "None"

표시할 Engagement 필드의 쉼표로 구분된 목록입니다.

​

반환값

GetInsightsHistoricalResponse - 응답 데이터

​

get_liking_users

좋아요한 사용자 가져오기 특정 게시물 ID를 기준으로, 해당 게시물에 좋아요를 누른 사용자 목록을 조회합니다.

​

매개변수

path.id · Any

단일 게시물 ID입니다.

path.max_results · int or None · 기본값: "None"

최대 결과 수입니다.

path.pagination_token · Any or None · 기본값: "None"

다음 페이지의 결과를 가져오는 데 사용하는 매개변수입니다.

path.user_fields · List or None · 기본값: "None"

표시할 User 필드를 쉼표로 구분한 리스트입니다.

path.expansions · List or None · 기본값: "None"

확장할 필드를 쉼표로 구분한 리스트입니다.

path.tweet_fields · List or None · 기본값: "None"

표시할 Tweet 필드를 쉼표로 구분한 리스트입니다.

​

반환

IteratorGetLikingUsersResponse

​

get_quoted

인용된 포스트 조회 특정 게시물의 ID를 사용해 해당 게시물을 인용한 포스트 목록을 조회합니다.

​

Parameters

path.id · Any

단일 게시물 ID입니다.

path.max_results · int or None · 기본값: "None"

반환할 결과의 최대 개수입니다.

path.pagination_token · Any or None · 기본값: "None"

지정된 ‘페이지’의 결과를 가져오는 데 사용하는 매개변수입니다.

path.exclude · List or None · 기본값: "None"

제외할 엔티티 집합입니다 (예: ‘replies’ 또는 ‘retweets’).

path.tweet_fields · List or None · 기본값: "None"

표시할 Tweet 필드의 쉼표로 구분된 목록입니다.

path.expansions · List or None · 기본값: "None"

확장할 필드의 쉼표로 구분된 목록입니다.

path.media_fields · List or None · 기본값: "None"

표시할 Media 필드의 쉼표로 구분된 목록입니다.

path.poll_fields · List or None · 기본값: "None"

표시할 Poll 필드의 쉼표로 구분된 목록입니다.

path.user_fields · List or None · 기본값: "None"

표시할 User 필드의 쉼표로 구분된 목록입니다.

path.place_fields · List or None · 기본값: "None"

표시할 Place 필드의 쉼표로 구분된 목록입니다.

​

반환값

IteratorGetQuotedResponse

​

get_reposted_by

리포스트한 사용자 조회 지정한 게시물 id를 기준으로, 해당 게시물을 리포스트한 사용자 목록을 조회합니다.

​

Parameters

path.id · Any

단일 게시물 ID입니다.

path.max_results · int or None · 기본값: "None"

결과의 최대 개수입니다.

path.pagination_token · Any or None · 기본값: "None"

다음 “페이지”의 결과를 가져오는 데 사용되는 매개변수입니다.

path.user_fields · List or None · 기본값: "None"

표시할 User 필드를 쉼표로 구분한 리스트입니다.

path.expansions · List or None · 기본값: "None"

확장할 필드를 쉼표로 구분한 리스트입니다.

path.tweet_fields · List or None · 기본값: "None"

표시할 Tweet 필드를 쉼표로 구분한 리스트입니다.

​

반환

IteratorGetRepostedByResponse

​

get_reposts

리포스트 가져오기 특정 게시물을 리포스트한 포스트 목록을 해당 게시물의 ID를 사용해 조회합니다.

​

Parameters

path.id · Any

단일 게시물 ID입니다.

path.max_results · int or None · 기본값: "None"

결과의 최대 개수입니다.

path.pagination_token · Any or None · 기본값: "None"

다음 “페이지”의 결과를 가져오는 데 사용되는 매개변수입니다.

path.tweet_fields · List or None · 기본값: "None"

표시할 Tweet 필드를 쉼표로 구분한 목록입니다.

path.expansions · List or None · 기본값: "None"

확장할 필드를 쉼표로 구분한 목록입니다.

path.media_fields · List or None · 기본값: "None"

표시할 Media 필드를 쉼표로 구분한 목록입니다.

path.poll_fields · List or None · 기본값: "None"

표시할 Poll 필드를 쉼표로 구분한 목록입니다.

path.user_fields · List or None · 기본값: "None"

표시할 User 필드를 쉼표로 구분한 목록입니다.

path.place_fields · List or None · 기본값: "None"

표시할 Place 필드를 쉼표로 구분한 목록입니다.

​

반환값

IteratorGetRepostsResponse

​

hide_reply

답글 숨기기 인증된 사용자가 소유한 대화에 달린 답글을 숨기거나 숨김을 해제합니다.

​

매개변수

path.tweet_id · Any

숨기거나 숨김 해제하려는 답글의 ID입니다.

body.body · HideReplyRequest

요청 본문

​

search_all

모든 포스트 검색 검색 쿼리와 일치하는 포스트를 전체 아카이브에서 조회합니다.

​

매개변수

path.query · str

포스트를 매칭하기 위한 하나의 쿼리/규칙/필터입니다. 최대 쿼리 길이를 확인하려면 https://t.co/rulelength를 참고하세요.

path.start_time · str or None · 기본값: "None"

YYYY-MM-DDTHH:mm:ssZ. 포스트가 제공될 가장 오래된 UTC 타임스탬프입니다. 타임스탬프는 초 단위의 정밀도를 가지며, 포함 범위입니다(예: 12:00:01은 해당 분의 첫 번째 초를 포함).

path.end_time · str or None · 기본값: "None"

YYYY-MM-DDTHH:mm:ssZ. 포스트가 제공될 가장 최신 UTC 타임스탬프입니다. 타임스탬프는 초 단위의 정밀도를 가지며, 제외 범위입니다(예: 12:00:01은 해당 분의 첫 번째 초를 제외).

path.since_id · Any or None · 기본값: "None"

지정된 ID보다 큰(즉, 더 최신) 포스트 ID를 가진 결과를 반환합니다.

path.until_id · Any or None · 기본값: "None"

지정된 ID보다 작은(즉, 더 오래된) 포스트 ID를 가진 결과를 반환합니다.

path.max_results · int or None · 기본값: "None"

요청당 반환할 검색 결과의 최대 개수입니다.

path.next_token · Any or None · 기본값: "None"

이 매개변수는 다음 ‘페이지’의 결과를 가져오는 데 사용됩니다. 이 매개변수에 사용하는 값은 API 응답에서 직접 가져온 값이며, 수정해서는 안 됩니다.

path.pagination_token · Any or None · 기본값: "None"

이 매개변수는 다음 ‘페이지’의 결과를 가져오는 데 사용됩니다. 이 매개변수에 사용하는 값은 API 응답에서 직접 가져온 값이며, 수정해서는 안 됩니다.

path.sort_order · str or None · 기본값: "None"

결과를 반환할 정렬 순서입니다.

path.tweet_fields · List or None · 기본값: "None"

표시할 Tweet 필드의 쉼표로 구분된 목록입니다.

path.expansions · List or None · 기본값: "None"

확장할 필드의 쉼표로 구분된 목록입니다.

path.media_fields · List or None · 기본값: "None"

표시할 Media 필드의 쉼표로 구분된 목록입니다.

path.poll_fields · List or None · 기본값: "None"

표시할 Poll 필드의 쉼표로 구분된 목록입니다.

path.user_fields · List or None · 기본값: "None"

표시할 User 필드의 쉼표로 구분된 목록입니다.

path.place_fields · List or None · 기본값: "None"

표시할 Place 필드의 쉼표로 구분된 목록입니다.

​

반환값

IteratorSearchAllResponse

​

search_recent

최근 포스트 검색 검색 쿼리와 일치하는 최근 7일 이내의 포스트를 반환합니다.

​

매개변수

path.query · str

포스트와 일치시키기 위한 하나의 쿼리/규칙/필터입니다. 최대 쿼리 길이를 확인하려면 https://t.co/rulelength를 참조하세요.

path.start_time · str or None · 기본값: "None"

YYYY-MM-DDTHH:mm:ssZ 형식입니다. 포스트가 제공될 수 있는 가장 오래된 UTC 타임스탬프입니다. 타임스탬프는 초 단위 정밀도를 가지며 포함됩니다(예: 12:00:01은 해당 분의 첫 번째 초를 포함).

path.end_time · str or None · 기본값: "None"

YYYY-MM-DDTHH:mm:ssZ 형식입니다. 포스트가 제공될 수 있는 가장 최신 UTC 타임스탬프입니다. 타임스탬프는 초 단위 정밀도를 가지며 제외됩니다(예: 12:00:01은 해당 분의 첫 번째 초를 제외).

path.since_id · Any or None · 기본값: "None"

지정한 ID보다 큰(즉, 더 최근인) 포스트 ID를 가진 결과만 반환합니다.

path.until_id · Any or None · 기본값: "None"

지정한 ID보다 작은(즉, 더 오래된) 포스트 ID를 가진 결과만 반환합니다.

path.max_results · int or None · 기본값: "None"

요청당 반환할 최대 검색 결과 수입니다.

path.next_token · Any or None · 기본값: "None"

다음 ‘페이지’의 결과를 가져오는 데 사용되는 매개변수입니다. 이 매개변수의 값은 API가 제공한 응답에서 직접 가져오며, 수정해서는 안 됩니다.

path.pagination_token · Any or None · 기본값: "None"

다음 ‘페이지’의 결과를 가져오는 데 사용되는 매개변수입니다. 이 매개변수의 값은 API가 제공한 응답에서 직접 가져오며, 수정해서는 안 됩니다.

path.sort_order · str or None · 기본값: "None"

결과를 반환하는 순서입니다.

path.tweet_fields · List or None · 기본값: "None"

표시할 Tweet 필드의 쉼표로 구분된 목록입니다.

path.expansions · List or None · 기본값: "None"

확장할 필드의 쉼표로 구분된 목록입니다.

path.media_fields · List or None · 기본값: "None"

표시할 Media 필드의 쉼표로 구분된 목록입니다.

path.poll_fields · List or None · 기본값: "None"

표시할 Poll 필드의 쉼표로 구분된 목록입니다.

path.user_fields · List or None · 기본값: "None"

표시할 User 필드의 쉼표로 구분된 목록입니다.

path.place_fields · List or None · 기본값: "None"

표시할 Place 필드의 쉼표로 구분된 목록입니다.

​

반환값

IteratorSearchRecentResponse