Advertiser API
어떤 것을 홍보할 수 있나요?
- 프로모션 광고는 더 많은 사용자에게 도달하거나 기존 팔로워의 참여를 이끌어내고자 하는 광고주가 구매하는 일반 광고입니다.
- 광고주가 X에서 노출 비용을 지불하는 경우 프로모션 광고에는 ‘프로모션’ 레이블이 명확히 표시됩니다. 그 외에는 일반 광고와 동일하게 작동하며 리포스트, 댓글, 좋아요 등 다양한 상호작용이 가능합니다. 일반적인 게재 규칙이 적용되며 POST statuses/update로 생성됩니다.
- ‘프로모션 전용’ 트윗은 POST accounts/:account_id/tweet으로 생성할 수 있으며, 프로모션 트윗 캠페인에 사용할 수 있지만 팔로워에게 노출되거나 공개 타임라인에 표시되지는 않습니다. 특정 계정의 프로모션 전용 트윗 목록을 조회하려면 GET accounts/:account_id/scoped_timeline을 사용하세요.
- 프로모티드 계정은 사용자가 아직 팔로우하지 않았지만 관심을 가질 만한 계정을 추천하는 Who to Follow 기능의 일부입니다. 프로모티드 계정은 사용자가 좋아할 수 있는 더 다양한 계정을 발견하도록 돕습니다.
- 타임라인용 프로모티드 계정은 프로모티드 트윗을 프로모티드 계정 캠페인과 연결해 사용자 타임라인에 표시합니다.
캠페인 및 광고 그룹(라인 아이템)
분석
X Ads API는 광고 성과를 추적하고 최적화할 수 있도록 다양한 분석 엔드포인트를 제공합니다. 자세한 내용은 Analytics 및 Analytics 모범 사례를 참조하세요. 청구 지표의 경우 데이터는 이벤트 발생 후 최대 3일 뒤에야 확정될 수 있습니다. 그전까지 해당 데이터는 잠정치로 간주해야 합니다. 최종 청구 금액 산정 대상 수치는 항상 잠정치보다 작습니다. 청구 대상 수치는 스팸 및 관련 저품질 트래픽을 반영해 조정됩니다. 시간 관련 기타 고려 사항은 Timezones를 참조하세요.캠페인 생성 - 단계별 안내
-v 옵션과 대략 동일한 -t를 사용해 호출을 추적하세요.
이 예시에서는 키워드 타기팅이 적용된 Promoted Ads 캠페인을 생성합니다.
- 계정 id를 조회합니다.
- 자금 조달 수단 id를 조회합니다.
- 캠페인을 생성하고 자금 수단에 연결합니다.
- 캠페인에 연동된 라인 아이템을 생성합니다.
- 라인 아이템에 연결된 타기팅 프로필을 생성합니다.
- 마지막으로 라인 아이템의 일시 중지를 해제합니다.
목표 기반 캠페인
objective를 설정하세요.
라인 아이템 쓰기 엔드포인트에서 사용되고 읽기 엔드포인트에서 반환되는 파라미터는 objective입니다. 이 필드는 현재 다음 값을 가집니다:
APP_ENGAGEMENTSAPP_INSTALLSFOLLOWERSENGAGEMENTSREACHVIDEO_VIEWSPREROLL_VIEWSWEBSITE_CLICKS
APP_ENGAGEMENTS에는 CPAC, APP_INSTALLS에는 CPAC 또는 CPI, WEBSITE_CLICKS에는 CPLC, FOLLOWERS에는 CPF, ENGAGEMENTS에는 CPE, REACH에는 CPM 등 목표별 가격 책정을 제공합니다.
모바일 앱 프로모션 캠페인에는 APP_ENGAGEMENTS 또는 APP_INSTALLS 목표가 반드시 포함되어야 합니다.
참고: 서로 다른 목표를 가진 라인 아이템을 동일한 캠페인에 포함할 수 없습니다.
| 캠페인 목표 | API objective | 트윗 내 미디어 | 가격 모델 |
|---|---|---|---|
| 앱 재참여 | APP_ENGAGEMENTS | 이미지 또는 동영상 앱 다운로드 카드 필수. | CPAC |
| 앱 설치 | APP_INSTALLS | 이미지 또는 동영상 앱 다운로드 카드 필수. | CPAC 또는 CPI (charge_by로 설정) |
| 도달 | REACH | 제한 없음. | CPM |
| 팔로워 | FOLLOWERS | 트윗은 필수는 아니지만 권장됩니다. 팔로워 캠페인의 트윗에는 미디어 제한이 없으나, 텍스트 전용 트윗을 권장합니다. 자세한 정보 | CPF |
| 참여 | ENGAGEMENTS | 제한 없음. | CPE |
| 동영상 조회 | VIDEO_VIEWS | 동영상 대화 카드, 동영상 또는 GIF 필수. | CPV 또는 3초/100% 조회 기준 비용 |
| 프리롤 조회 | PREROLL_VIEWS | 동영상 필수. | CPV 또는 3초/100% 조회 기준 비용 |
| 웹사이트 클릭 | WEBSITE_CLICKS | 웹사이트 카드를 권장하지만 필수는 아닙니다. 트윗에는 웹사이트 카드 또는 웹사이트 링크 중 하나만 포함되어야 합니다(둘 다는 불가). | CPLC |
자금 조달 수단
funding_instruments 목록을 가져오려면 GET accounts/:account_id/funding_instruments를, 특정 항목의 세부 정보는 GET accounts/:account_id/funding_instruments/:funding_instrument_id를 참조하세요.
자금 조달 수단 속성
account_id, 자금 조달 수단 id, 자금 조달 수단 type, description, 그리고 io_header(인서션 오더 헤더 ID). 하나의 io_header는 여러 자금 조달 수단에 연결될 수 있습니다.
자금 조달 가능 여부: able_to_fund 및 reasons_not_able_to_fund.
시간: 문자열로 표현되는 created_at, updated_at, start_time, end_time이며, 형식은 “%Y-%m-%dT%l:%M:%S%z”입니다.
불리언 상태: paused, deleted, cancelled(true 또는 false).
재무: currency(ISO-4217 형식), credit_limit_local_micro, credit_remaining_local_micro, funded_amount_local_micro. 통화 값은 마이크로 단위로 표시됩니다. USD의 경우 $5.50은 5.50*1e6, 즉 5,500,000으로 인코딩됩니다. “정수 값”을 표현하려면 모든 통화에서 로컬 마이크로 값에 1e6(1_000_000)을 곱해야 합니다.
속성 세부정보
credit_limit_local_micro는 CREDIT_CARD 또는 CREDIT_LINE 유형의 자금 조달 수단에만 유효하며, 해당 수단의 신용한도를 나타냅니다.
funded_amount_local_micro는 INSERTION_ORDER 유형의 자금 조달 수단에만 유효하며, 배정 예산을 나타냅니다.
credit_remaining_local_micro는 CREDIT_LINE 및 AGENCY_CREDIT_LINE 유형의 자금 조달 수단에 유효합니다. 이는 해당 자금 조달 수단에서 이미 지출된 금액을 credit_limit_local_micro에서 뺀 값을 의미합니다. 이는 funded_amount_local_micro와 지출 금액의 차이를 의미하지 않습니다. 신용한도와 배정 금액은 광고주와의 서로 다른 기초 자금 조달 방식과 지출 약정을 반영하므로 구분합니다.
자금 조달 수단의 종류
타기팅
게재 위치별 타기팅 옵션
- X Search: 연령 타기팅, 기기, 이벤트, 성별, 키워드 유형(전체), 언어, 위치, 네트워크 활성화, 이동통신사, 플랫폼, 플랫폼 버전, 맞춤형 오디언스, Wi‑Fi 전용
- X Timeline: 연령 타기팅, 기기, 이벤트, 팔로워의 팔로워, 유사 팔로워, 성별, 관심사, 언어, 위치, 네트워크 활성화, 이동통신사, 비정확 일치 키워드 유형, 파트너 오디언스 유형, 플랫폼, 플랫폼 버전, 리타기팅 유형, 맞춤형 오디언스, TV 타기팅 유형, Wi‑Fi 전용
- X Profiles & Tweet Details: 연령 타기팅, 기기, 이벤트, 팔로워의 팔로워, 유사 팔로워, 성별, 관심사, 언어, 위치, 네트워크 활성화, 이동통신사, 비정확 일치 키워드 유형, 파트너 오디언스 유형, 플랫폼, 플랫폼 버전, 리타기팅 유형, 맞춤형 오디언스, TV 타기팅 유형, Wi‑Fi 전용
타기팅 유형 이해하기
NETWORK_OPERATOR를 사용해 모바일 통신사 기반으로 사용자를 타기팅할 수 있도록 합니다.
새 모바일 기기 타기팅: 사용자가 해당 기기로 처음 X에 접속한 날짜를 기준으로 도달합니다. 타기팅 유형 NETWORK_ACTIVATION_DURATION을 사용하고, operator_type으로 미만은 LT, 이상은 GTE를 사용합니다.
플랫폼, 플랫폼 버전, 디바이스, 및 WiFi 전용: 다양한 기준으로 모바일 디바이스를 타기팅할 수 있습니다. 플랫폼은 광범위한 휴대폰 범주를 포괄하는 상위 수준의 타기팅 유형입니다. 예시 값은 iOS 및 Android입니다. 디바이스를 사용하면 iPhone 5s, Nexus 4, Samsung Galaxy Note처럼 특정 모바일 디바이스 사용자를 타기팅할 수 있습니다. 플랫폼 버전을 사용하면 특정 모바일 운영체제의 버전별(포인트 릴리스까지) 사용자를 타기팅할 수 있습니다. 예로 iOS 7.1과 Android 4.4가 있습니다. WiFi 전용은 WiFi 네트워크를 사용하는 사용자만 타기팅합니다. 이 설정을 사용하지 않으면 통신사 연결과 WiFi를 모두 사용하는 사용자도 타기팅됩니다.
- 플랫폼과 디바이스에 겹침이 없으면 동시에 타기팅할 수 있습니다. 예: 플랫폼으로 Blackberry, 디바이스로 iPad Air를 동시에 타기팅할 수 있습니다.
- 디바이스와 OS 버전은 동시에 타기팅할 수 있습니다. 예: iPad Air와 iOS >= 7.0을 타기팅할 수 있습니다.
- 디바이스보다 더 광범위한 플랫폼은 함께 타기팅할 수 없습니다. 예: iOS와 iPad Air를 함께 타기팅할 수 없습니다.
TV_SHOW 타겟팅 유형으로 지속적으로 타겟팅되도록 구성할 수 있습니다. 사용 가능한 TV 프로그램을 확인하려면 GET targeting_criteria/tv_markets 및 GET targeting_criteria/tv_shows 엔드포인트를 사용하세요.
Tweet Engager Retargeting
Tweet engager 리타겟팅은 광고주가 X에서 프로모션 또는 오가닉 Tweet에 노출되었거나 상호작용한 사용자들을 기기 전반에서 타겟팅할 수 있도록 합니다. 이를 통해 광고주는 X에서 광고주의 콘텐츠를 보았거나 상호작용한 사람들에게 후속 메시지나 오퍼로 다시 도달해 추가 상호작용 또는 전환 가능성이 높은 대상을 공략할 수 있습니다. 사용자는 노출 또는 상호작용 후 수분 내 타겟팅 대상이 되며, 상호작용은 최대 90일, 노출은 최대 30일 동안 자격이 유지됩니다.
Tweet Engager 타겟팅 유형:
ENGAGEMENT_TYPE: 타겟팅 값으로IMPRESSION또는ENGAGEMENT를 허용합니다. 노출된 사용자(IMPRESSION)를 타겟팅할지, 상호작용한 사용자(ENGAGEMENT)를 타겟팅할지 지정합니다.CAMPAIGN_ENGAGEMENT: 캠페인 ID를 타겟팅 값으로 사용합니다. 이 캠페인에서 상호작용했거나 노출된 사용자(ENGAGEMENT_TYPE에 따라)가 타겟팅됩니다.USER_ENGAGEMENT: 프로모션된 사용자 ID를 타겟팅 값으로 사용하여 광고주의 오가닉 콘텐츠에 노출되었거나 상호작용한 사용자(ENGAGEMENT_TYPE에 따라)를 타겟팅합니다. Ads 계정과 연결된 프로모션된 사용자 ID여야 합니다.
ENGAGEMENT_TYPE은 하나 이상의 유효한 CAMPAIGN_ENGAGEMENT 또는 USER_ENGAGEMENT 값과 함께 필수입니다. 두 가지 tweet engager 타겟팅 유형을 모두 사용할 수 있으며, 하나의 라인 아이템에서 여러 캠페인을 타겟팅할 수 있습니다.
Video Viewer Targeting: Video viewer 타겟팅은 Tweet engager 타겟팅을 확장하여, X에서 동영상의 일부 또는 전부를 시청한 오디언스를 타겟팅할 수 있도록 합니다. 광고주는 오가닉 동영상, 프로모션 동영상, 또는 둘 다를 타겟팅할 수 있습니다. 프로모션 동영상은 동영상 조회 목표 캠페인이나 라인 아이템으로만 제한되지 않습니다.
Video Viewer 타겟팅 유형:
VIDEO_VIEW: 동영상을 재생하기 위해 클릭했거나 자동 재생으로 3초 이상 시청한 사용자VIDEO_VIEW_PARTIAL: 동영상의 50%를 시청한 사용자VIDEO_VIEW_COMPLETE: 동영상의 95% 이상을 시청한 사용자
ENGAGEMENT_TYPE을 사용하는 경우 라인 아이템의 타겟팅 기준에 다음 중 하나 이상이 함께 포함되어야 합니다:
CAMPAIGN_ENGAGEMENT: 캠페인 ID를 타겟팅 값으로 사용합니다. 이 캠페인에서 동영상을 시청한 사용자(ENGAGEMENT_TYPE기준)가 타겟팅됩니다.USER_ENGAGEMENT: 프로모션된 사용자 ID를 타겟팅 값으로 사용하여 광고주의 오가닉 콘텐츠에서 동영상을 시청한 사용자(ENGAGEMENT_TYPE기준)를 타겟팅합니다. Ads 계정과 연결된 프로모션된 사용자 ID여야 합니다.
- Broad(기본값): 단어 순서와 무관하게 모든 단어가 일치합니다. 대소문자, 복수형, 시제에 영향을 받지 않습니다. 가능한 경우 자동으로 확장됩니다(예: “car repair”는 “automobile fix”에도 일치). 확장 없이 타겟팅하려면 “+boat +jet”처럼 키워드 앞에 + 기호를 추가하세요. + 없이 키워드를 사용하면 Broad Match가 기본으로 적용됩니다.
- Unordered(사용 중단): 단어 순서와 무관하게 모든 단어가 일치합니다. 대소문자, 복수형, 시제에 영향을 받지 않습니다.
- Phrase: 정확한 키워드 문자열과 일치하며, 다른 키워드가 함께 있어도 됩니다.
- Exact: 정확히 해당 키워드 문자열과만 일치하며, 다른 것은 일치하지 않습니다.
- Negative: 쿼리 내 어딘가에 이 모든 키워드가 포함된 검색과의 일치를 피합니다. 순서와 무관하며 다른 단어가 있어도 해당됩니다.
- Negative Phrase: 쿼리 내 어딘가에 이 정확한 키워드 문자열이 포함된 검색과의 일치를 피합니다. 다른 단어가 있어도 해당됩니다.
- Negative Exact: 이 키워드와 정확히 일치하고 다른 단어가 포함되지 않은 검색과의 일치를 피합니다.
타기팅 기준 조합
| “Primary” 유형 | 기타 유형 |
| 팔로워 | 위치 |
| 맞춤 고객 | 성별 |
| 관심사 | 언어 |
| 키워드 | 디바이스 및 플랫폼 |
| TV | 연령 |
- “Primary” 타기팅 유형은 **∪**로 결합됩니다(즉, 논리적 합집합).
- 기타 타기팅 유형은 AND로 결합됩니다.
- 동일한 유형끼리는 OR로 결합됩니다.
- 미국, 영국, 캐나다의 X 사용자(위치)
- 여성(성별)
- 맞춤 고객 목록 기반(“Primary”)
- 키워드 포함(“Primary”)
추가 예시
- 성별과 지역을 선택하고 기본(primary)은 선택하지 않음: (Male) AND (US OR GB)
- 성별, 지역, 관심사를 선택: (Female) AND (CA) AND (Computers OR Technology OR Startups)
- 성별, 지역, 관심사, 맞춤 잠재고객(Tailored Audiences), 키워드를 선택: (Male) AND (GB) AND (Cars ∪ Tailored Audiences for CRM ∪ autocross)
예산 페이싱
standard_delivery 매개변수를 false로 설정하여 가속 게재로 전환하세요(참고: GET accounts/:account_id/campaigns).
참고 사항
- “하루(Day)”는 X 광고주 계정 시간대(예: America/Los_Angeles)를 기준으로 합니다.
- 초기 결과에 따르면 표준 게재는 하루 전반에 걸쳐 더 일관된 커버리지를 제공하며, 광고주의 eCPE/CPF 개선에 도움이 됩니다.
타겟팅 입찰
입찰 전략
| 캠페인 목표 | 레거시 | Ads API v10+ |
| 앱 설치 | bid_type = AUTObid_unit = APP_INSTALLScharge_by = APP_CLICKS | goal = APP_INSTALLSbid_strategy = AUTO |
| 웹사이트 클릭 | bid_type = TARGET (참고: 일부 캠페인 목표에서는 bid_unit가 필요하지 않음) | bid_strategy = TARGET |
타겟 입찰
타겟 입찰을 사용하면 지불을 원하는 목표 비용을 지정할 수 있으며, X Ads 플랫폼은 해당 목표 비용에 근접하거나 그 이하를 유지하면서 성과 중심으로 캠페인을 최적화합니다. 이 기능은 비용을 통제하면서 원하는 행동(예: 링크 클릭, 잠재고객 확보, 팔로우)을 할 가능성이 높은 사용자에게 효과적으로 도달할 수 있는 유연성을 제공합니다. 캠페인 설정과 최적화(입찰 옵션 포함)에 더 다양한 선택지를 원하는 광고주에게 매우 유용한 기능입니다. 호환되는 캠페인 목표를 사용하는 라인 아이템의 경우, 지불 목표 비용을 지정할 수 있는 새로운 입찰가 책정 메커니즘을 도입했습니다. 당사 광고 플랫폼은 지정한 목표의 평균 비용을 설정값의 20% 이내로 유지하도록 노력하면서 더 많은 성과를 달성할 수 있도록 동적으로 대리 입찰합니다. 라인 아이템의bid_strategy 설정을 TARGET 값으로 지정하면 다음과 같은 관련 캠페인 목표에서 타겟 입찰을 활성화할 수 있습니다:
WEBSITE_CLICKSWEBSITE_CONVERSIONSAPP_INSTALLSAPP_ENGAGEMENTSREACH
국가 타기팅 및 노출 요건
러시아
파트너 관리 결제 수단
파트너 초기 설정
- 파트너는 PGP/GPG 공개 키를 제공해야 합니다. Ads API 파트너와 X 간에는 공유 비밀 키를 교환해야 합니다. 이는 온보딩 과정에서 데이터를 검증하는 데 사용됩니다.
- Ads API 액세스에 사용할 X 앱의
app_id또는consumer_secret. developer.x.com에서 X 계정으로 로그인되어 있다면 앱 대시보드에서 기존 X 앱을 확인하고 수정할 수 있습니다. 새 X 앱을 만들어야 하는 경우 승인된 개발자 계정이 필요합니다. X는 프로덕션+샌드박스 용 앱 1개와 샌드박스 전용(선택 사항) 앱 1개를 허용합니다. 해당 X 앱은 기업의 파트너가 관리하는 X 핸들에서 생성되어야 합니다.
광고주 온보딩 흐름
- 사용자가 파트너 웹사이트에서 온보딩을 시작하고 온보딩할 핸들을 입력합니다.
- 파트너는 서명된 페이로드와 함께 사용자를 ads.x.com의 URL로 리디렉션합니다. 이 페이로드에는 파트너의 API
app_id, 온보딩할 X 핸들의 Xuser_id, 콜백 URL 및 아래에 문서화된 기타 필드가 포함됩니다. - 사용자는 표준 x.com 로그인 페이지를 통해 ads.x.com에 로그인하라는 요청을 받습니다.
- 사용자가 로그인하면 온보딩 프로세스가 시작됩니다. 이 단계에는 광고 검토, 계정 검증 및 기타 점검이 포함됩니다.
- 모든 온보딩 작업이 완료되면 사용자는 Ads API 파트너가 제공한 콜백 URL로 리디렉션되며, 성공 또는 실패를 나타내는 페이로드가 함께 전달됩니다. 여기에는 3-legged 권한 부여 프로세스가 포함됩니다.
온보딩 리디렉트 페이로드
| 이름 | 유형 | 설명 |
| callback_url | URL 인코딩된 문자열 | 계정 연결 프로세스가 완료된 후 결과와 관계없이 사용자가 이 URL로 리디렉트됩니다. 프로토콜 세부 정보는 파트너 리디렉트 URL 섹션을 참조하세요 |
| client_app_id | 정수 | 관리 파트너를 식별하는 데 사용되는 X API 클라이언트 앱 id |
| promotable_user_id | 정수 | 관리 파트너가 프로모션을 관리할 @handle의 X user_id. ads.x.com에 로그인해 연결 프로세스를 완료하는 사용자와 동일한지 확인하는 데 사용됩니다 |
| fi_description | URL 인코딩된 문자열(최대 255자) | 자금 조달 수단(funding instrument) 이름. API에서 자금 조달 수단을 조회할 때 설명 필드에 표시됩니다. funding_instrument 설명이 제공되면 기존 funding_instrument는 일시 중지되고 새로운 관리 파트너 자금 조달 수단이 설정됩니다. (동일한 이름의 항목이 이미 있으면 아무 작업도 수행되지 않습니다) |
| timezone | Area/Location 형식의 문자열 | 일일 예산 적용 기준 일자와 청구 집계에 사용될 표준시간대 |
| currency | ISO 4217 통화 코드 | 입찰 입력 및 청구에 사용될 통화 |
| country | ISO 3166-1 alpha-2 국가 코드 | 계정의 청구 국가 |
| signature | 아래에 설명된 대로 URL 인코딩 및 base64 인코딩된 바이너리 코드 | 공유 비밀과 다른 매개변수를 결합해 호출의 진위와 매개변수의 유효성을 검증하는 서명 |
콜백 URL 페이로드
| Name | Type | Description |
| status | string | OK 새 계정이 생성되었거나 기존의 적격 계정이 확인됨. ACCOUNT_INELIGIBLE 파트너별 제한 조건을 충족하지 않음 USER_MISMATCH ads.x.com에 로그인한 X 계정이 계정 연결 요청의 promotable_user_id 와 다름 INCOMPLETE_SERVING_BILLING_INFO 표준 시간대, 통화 또는 국가가 지정되지 않음 INVALID_COUNTRY 잘못된 국가 값이 제공됨 INVALID_CURRENCY 잘못된 통화 값이 제공됨 INVALID_TIMEZONE 잘못된 표준 시간대 값이 제공됨 |
| account_id | URL 인코딩된 string | 연결된 계정의 X Ads 계정 id |
| funding_instrument_id | URL 인코딩된 string | 활성 파트너 관리 결제 수단의 ID |
| signature | 아래에 설명된 대로 URL 인코딩 및 base64 인코딩된 이진 코드 | 공유 시크릿과 다른 매개변수를 결합해 호출의 진위와 매개변수의 유효성을 검증하는 Base64 인코딩된 HMAC-SHA1 서명. 콜백 URL이 계정 연결 프로세스가 의도된 X user_id 에 대해서만 유효하도록, 요청에 서명할 때 공유 시크릿에 X user_id 를(& 사용) 덧붙여야 합니다. |
user_id에 대해서만 유효하도록, 요청에 서명할 때 공유 시크릿에 X user_id를(& 사용) 덧붙여야 합니다.
요청 및 콜백 URL 서명
/link_managed_account에 대한 요청과 콜백 URL의 유효성을 보장하려면, 요청을 발신 측에서 서명하고 수신자가 조치하기 전에 이를 검증해야 합니다. X와 관리 파트너 간에 공유된 시크릿으로 요청에 서명하면 각 당사자는 권한 있는 상대가 보낸 요청만 수락하게 됩니다.
서명 생성 알고리즘은 OAuth에서 사용되는 방식과 유사합니다.
다음과 같이 서명 베이스 문자열을 생성합니다:
- HTTP 메서드를 대문자로 변환하고, 이 값을 베이스 문자열로 설정합니다.
- 베이스 문자열에 ‘&’ 문자를 추가합니다.
- URL(매개변수 제외)을 퍼센트 인코딩하여 베이스 문자열에 추가합니다.
- 베이스 문자열에 ‘&’ 문자를 추가합니다.
- 다음과 같이 구성된 퍼센트 인코딩된 쿼리 문자열을 추가합니다:
- 서명 대상이 될 모든 키와 값을 퍼센트 인코딩합니다.
- 매개변수 목록을 키 기준으로 알파벳순으로 정렬합니다.
- 각 키/값 쌍에 대해(파트너 리디렉트 URL의 경우 primary_promotable_user_id 포함):
- 퍼센트 인코딩된 키를 쿼리 문자열에 추가합니다.
- 베이스 문자열에 ‘=’ 문자를 추가합니다.
- 퍼센트 인코딩된 값을 쿼리 문자열에 추가합니다.
- 퍼센트 인코딩된 key=value 쌍을 ‘&’ 문자로 구분합니다.
- 이전에 교환한 공유 시크릿을 키로, 베이스 문자열을 값으로 하여 HMAC-SHA1 알고리즘을 사용해 서명을 생성합니다.
- 2단계의 출력값을 Base64로 인코딩하고, 마지막 개행 문자를 제거한 뒤 3단계에서 생성된 서명을 퍼센트 인코딩하여 signature 매개변수로 URL에 추가합니다.
서명 예시
KBxQMMSpKRrtg9aw3qxK4fTXvUc=
그런 다음 이 서명은 원본 URL의 끝에 signature 매개변수로 추가됩니다(퍼센트 인코딩, 단계 4):
https://ads.x.com/link_managed_account?callback_url=https%3A%2F%2Fmanagingpartner.com%2Flink_account_callback&client_app_id=12345&fi_description=some%20name&promotable_user_id=1&signature=KBxQMMSpKRrtg9aw3qxK4fTXvUc%3D
파트너 리디렉트 URL(계정 링크 요청 콜백) 서명하기 GET 요청이라고 가정했을 때 서명할 URL:
https://managingpartner.com/link_account_callback?status=OK&account_id=ABC&funding_instrument_id=DEF
이 URL에는 다음 매개변수가 포함됩니다:
account_id = ABC, funding_instrument_id = DEF, status = OK
HTTP 메서드와 매개변수 없는 URL로 구성된 기본 문자열(단계 a - d)은 다음과 같습니다:
GET https%3A%2F%2Fmanagingpartner.com%2Flink_account_callback&“
단계 e의 하위 단계에서 생성된 쿼리 문자열은 다음과 같습니다:
account_id=ABC&funding_instrument_id=DEF&status=OK
퍼센트 인코딩된 쿼리 문자열은 다음과 같습니다:
account_id%3DABC%26funding_instrument_id%3DDEF%26status%3DOK
단계 a - d와 e를 결합한 전체 기본 문자열:
GET https%3A%2F%2Fmanagingpartner.com%2Flink_account_callback&account_id%3DABC%26funding_instrument_id%3DDEF%26status%3DOK
hmac-sha1 알고리즘을 사용하여 “secret”라는 단어와 원래 링크 요청이 이루어진 X 사용자 id(위의 promotable_user_id = 1) 1을 키로 결합해 “secret&1”로 서명합니다.
결과는 Base64로 인코딩되며, 마지막 “\n” 없이 표시됩니다(단계 2 및 3): jDSHDkHJIFXpPLVxtA3a9d4bPjM=
이 서명은 이후 서명 매개변수에 원래 URL의 끝부분에(퍼센트 인코딩된 상태로) 추가됩니다(4단계):
https://managingpartner.com/link_account_callback?&status=OK&account_id=ABC&funding_instrument_id=DEF&signature=jDSHDkHJIFXpPLVxtA3a9d4bPjM%3D
서명 알고리즘은 여러 키와 함께 반복해서 실행될 수 있어야 합니다. 이렇게 하면 복수의 공유 키를 사용할 수 있고, 주기적으로 공유 키를 교체(로테이션)할 수 있습니다.
partner_managed_funding_instrument 생성
fi_description 매개변수가 제공되고 계정에 동일한 이름의 partner_managed_funding_instrument가 없다면, 새로운 partner_managed_funding_instrument가 생성되며 기존의 모든 partner_managed_funding_instrument가 일시 중지됩니다. 동일한 이름의 partner_managed_funding_instrument가 이미 존재하는 경우 새로 생성되지 않습니다.온보딩 플로우 반복 호출 / 토큰 갱신
리디렉션 불가 오류 플로우
PMFI의 지속 업데이트
게재 위치
placements 매개변수를 사용해 라인 아이템에서 설정합니다. 가능한 값은 다음과 같습니다:
ALL_ON_TWITTERPUBLISHER_NETWORKTWITTER_PROFILETWITTER_SEARCHTWITTER_TIMELINESPOTLIGHTTREND
product_type과 objective에 따라 허용되는 게재 위치가 결정됩니다. 각 제품 유형별로 유효한 게재 옵션을 조회하려면 GET line_items/placements 엔드포인트를 사용할 수 있습니다.
또한, 아래 표에는 유효한 게재 위치와 목표의 조합이 나열되어 있습니다.
| 목표 | ALL_ON_TWITTER | TWITTER_PROFILE | TWITTER_SEARCH | TWITTER_TIMELINE |
|---|---|---|---|---|
APP_ENGAGEMENTS | ✔ | ✔ | ✔ | ✔ |
APP_INSTALLS | ✔ | ✔ | ✔ | ✔ |
REACH | ✔ | ✔ | ✔ | ✔ |
FOLLOWERS | ✔ | ✔ | ✔ | ✔ |
ENGAGEMENTS | ✔ | ✔ | ✔ | ✔ |
VIDEO_VIEWS | ✔ | ✔ | ✔ | ✔ |
PREROLL_VIEWS | ✔ | ✔ | ✔ | ✔ |
WEBSITE_CLICKS | ✔ | ✔ | ✔ | ✔ |
TWITTER_PROFILE 게재 위치만 지정하는 것은 불가능합니다.
참고: TWITTER_SEARCH에는 키워드 타기팅이 필요합니다.
참고: REACH 목표에는 반드시 TWITTER_TIMELINE 게재 위치가 포함되어야 합니다. ALL_ON_TWITTER, TWITTER_TIMELINE을 포함하는 임의의 게재 위치 조합, 또는 TWITTER_TIMELINE 단독으로 설정할 수 있습니다.
광고 그룹 FAQ
광고 그룹이란 무엇인가요?
Ad Group는 어떻게 생성하나요?
왜 Ad Groups 지원을 추가해야 하나요?
Ad Groups 캠페인에서 라인 아이템 예산은 캠페인 예산과 어떻게 연관되나요?
광고 그룹이 단일 라인 아이템보다 더 나은 성과를 내나요?
안내서
동영상 조회 프리롤 목표
필요한 엔드포인트
- 청크 업로드(Chunked media upload) (동영상 업로드용)
- POST accounts/:account_id/media_library (광고 계정에 동영상 연결)
- POST accounts/:account_id/campaigns (캠페인 생성)
- GET content_categories (콘텐츠 카테고리와 IAB 카테고리 매핑 조회)
- GET accounts/:account_id/curated_categories
- GET publishers
- POST accounts/:account_id/line_item_curated_categories
- POST accounts/:account_id/line_items (광고 그룹 생성)
- POST accounts/:account_id/media_creatives (광고 그룹에 동영상 연결)
- POST accounts/:account_id/preroll_call_to_action (CTA 및 리디렉션 URL 설정)
- POST batch/accounts/:account_id/targeting_criteria (타기팅)
단계
비디오 업로드
비디오 미디어 업로드
INIT 단계에서 media_category=amplify_video를 전달해야 합니다. 비디오는 청크로 나눠 업로드합니다. STATUS가 state 값으로 succeeded를 반환하면 다음 단계로 진행할 수 있습니다. 청크 엔드포인트를 사용한 미디어 업로드에 대한 자세한 내용은 Promoted Video Overview에서 확인하세요.
광고 계정에 동영상 추가
STATUS 명령으로 반환된 상태가 succeeded가 되면, 해당 엔드포인트에서 반환된 media_key를 사용해 POST accounts/:account_id/media_library 엔드포인트로 광고주의 미디어 라이브러리에 동영상을 추가합니다.
캠페인 설정하기
캠페인 생성
objective는 VIDEO_VIEWS_PREROLL로, product_type은 MEDIA로 설정해야 합니다. 또한 categories 매개변수도 해당 광고주 업종 카테고리로 설정해야 합니다.
라인 아이템 생성
categories 매개변수를 “Science & Education”으로 설정하려면, iab_categories의 전체 집합(즉, "IAB5", "IAB15")을 라인 아이템에 다음과 같이 설정해야 합니다:
퍼블리셔 선택
큐레이션된 카테고리
- 라인 아이템은 큐레이션된 카테고리의 country_code에 따라 해당 국가를 타겟팅해야 합니다.
- POST line_item_curated_categories 엔드포인트를 사용하여 라인 아이템을 특정 curated_category_id와 연결해야 합니다.
콘텐츠 카테고리
참고: GET curated_categories 응답에 포함된 전체 iab_categories 집합은 타기팅 기준 엔드포인트를 통해 모두 타기팅해야 합니다. 그렇지 않으면 검증 오류가 발생합니다.
계정 미디어(동영상)를 라인 아이템에 연결
CTA와 대상 URL 설정
VIDEO_VIEWS_PREROLL 목표는 프로모션 게시물(Promoted Tweets)이나 카드(Cards)를 사용하지 않습니다. 대신 동영상 크리에이티브는 광고 그룹(라인 아이템)에 연결되고, CTA 정보는 preroll_call_to_action 엔터티에 연결됩니다. POST accounts/:account_id/preroll_call_to_action 엔드포인트를 사용하면 버튼 CTA와 대상 URL을 구성할 수 있습니다.
타기팅 기준 설정
CONTENT_PUBLISHER_USER를 사용하세요. 제외할 핸들의 X user_id 또는 publisher_user_id를 제공하세요.
GET publishers 엔드포인트를 사용하면 콘텐츠 카테고리에서 제외할 user_id 목록을 조회할 수 있습니다. GET curated_categories 응답에 반환되는 publisher_user_id를 사용하면 큐레이션 카테고리에 대해서도 유사한 제외 목록을 조회할 수 있습니다.
참고: 큐레이션 카테고리에서는 최대 5개의 publisher_user_id, 콘텐츠 카테고리에서는 최대 50개의 user_id를 제외할 수 있습니다.
캠페인 시작
분석
VIDEO_VIEWS_PREROLL 캠페인의 분석 데이터는 통계 엔드포인트를 통해 확인할 수 있습니다.
타임라인 키워드 타게팅
어떻게 작동하나요?
targeting_type을 unordered_keywords 또는 phrase_keywords로 설정하세요.
빠른 시작 가이드
- 배치를
ALL_ON_TWITTER또는TWITTER_TIMELINE으로 설정해 새 라인 아이템을 생성합니다. POST accounts/:account_id/line_items - 방금 만든 라인 아이템에 대해 타기팅 기준을
BROAD_KEYWORD로 생성하고 키워드 값을 설정합니다. POST accounts/:account_id/targeting_criteria - 다음 엔드포인트로 키워드를 업데이트할 수 있습니다: PUT accounts/:account_id/targeting_criteria
- 캠페인이 실행되면 라인 아이템의 성과를 평가할 수 있도록 통계를 가져옵니다. GET stats/accounts/:account_id
API 레퍼런스
계정
https://ads-api.x.com/12/accounts
Parameters
| Name | Description |
|---|---|
| account_ids optional | 쉼표로 구분된 식별자 목록을 지정해 응답을 원하는 계정 ID로만 제한합니다. Type: string Example: 18ce54d4x5t |
| count optional | 각 요청당 조회를 시도할 레코드 수를 지정합니다. Type: int Default: 200 Min, Max: 1, 1000 |
| cursor optional | 다음 결과 페이지를 가져오기 위한 커서를 지정합니다. 자세한 내용은 Pagination을 참조하세요. Type: string Example: 8x7v00oow |
| q optional | name으로 리소스를 범위 지정하기 위한 선택적 쿼리입니다. Note: 대소문자를 구분하지 않는 접두 일치를 수행합니다. Type: string Min, Max length: 1, 255 |
| sort_by optional | 지원되는 속성을 기준으로 오름차순 또는 내림차순으로 정렬합니다. 자세한 내용은 Sorting을 참조하세요. Type: string Example: created_at-asc |
| with_deleted optional | 삭제된 결과를 포함합니다. Type: boolean Default: false Possible values: true, false |
| with_total_count optional | total_count 응답 속성을 포함합니다. Note: 이 매개변수와 cursor는 상호 배타적입니다. Note: total_count를 포함하는 요청에는 더 낮은 요청 한도가 적용되며, 현재 15분당 200으로 설정되어 있습니다. Type: boolean Default: false Possible values: true, false |
GET accounts/:account_id
인증된 사용자가 접근 권한을 가진 특정 계정을 조회합니다. 리소스 URLhttps://ads-api.x.com/12/accounts/:account_id
매개변수
| 이름 | 설명 |
|---|---|
| account_id 필수 | 사용 중인 계정의 식별자입니다. 리소스 경로에 포함되며, GET accounts를 제외한 모든 Advertiser API 요청에서 일반적으로 필수 매개변수입니다. 지정된 계정은 인증된 사용자와 연결되어 있어야 합니다. 유형: string 예시: 18ce54d4x5t |
| with_deleted 선택 | 삭제된 결과를 포함합니다. 유형: boolean 기본값: false 가능한 값: true, false |
GET https://ads-api.x.com/12/accounts/18ce54d4x5t
예시 응답
https://ads-api-sandbox.x.com/12/accounts
매개변수
없음
요청 예시
POST https://ads-api-sandbox.x.com/12/accounts
응답 예시
PUT accounts/:account_id
계정 이름 및/또는 업종 유형을 업데이트합니다. Resource URLhttps://ads-api.x.com/12/accounts/:account_id
Parameters
| Name | Description |
|---|---|
| account_id required | 사용 중인 계정의 식별자입니다. 리소스 경로에 포함되며, GET accounts를 제외한 모든 Advertiser API 요청에서 일반적으로 필수 매개변수입니다. 지정된 계정은 인증된 사용자와 연결되어 있어야 합니다. Type: string Example: 18ce54d4x5t |
| name optional | 계정 이름입니다. Type: string Example: API McTestface |
| industry_type optional | 계정이 속한 업종입니다. Type: string Possible values: AGENCY, BUSINESS_TO_BUSINESS, ONLINE_SERVICES, EDUCATION, FINANCIAL, HEALTH, GOVERNMENT, MEDIA, MOBILE, RESTAURANT, RETAIL, TECHNOLOGY, TRAVEL, OTHER |
PUT https://ads-api.x.com/12/accounts/18ce54d4x5t?name='API McTestface 2'&industry_type=TECHNOLOGY
Example Response
DELETE accounts/:account_id
참고: 샌드박스 전용 샌드박스 환경에서 광고 계정을 삭제합니다. 리소스 URLhttps://ads-api-sandbox.x.com/12/accounts/:account_id
매개변수
| 이름 | 설명 |
|---|---|
| account_id required | 사용 중인 계정의 식별자입니다. 리소스 경로에 포함되며, GET accounts를 제외한 모든 Advertiser API 요청에서 일반적으로 필요한 매개변수입니다. 지정된 계정은 인증된 사용자와 연결되어 있어야 합니다. 유형: string 예: 18ce54d4x5t |
DELETE https://ads-api-sandbox.x.com/12/accounts/gq12fh
예시 응답
계정 앱
GET account_apps
지정한 광고 계정과 연동된 모든 모바일 앱의 세부 정보를 조회합니다. Resource URLhttps://ads-api.x.com/12/accounts/:account_id/account_apps
Parameters
| Name | Description |
|---|---|
| account_id required | 사용 중인 계정의 식별자입니다. 리소스 경로에 포함되며, GET accounts를 제외한 모든 Advertiser API 요청에서 일반적으로 필수 매개변수입니다. 지정한 계정은 인증된 사용자와 연동되어 있어야 합니다. Type: string Example: 18ce54d4x5t |
| count optional | 요청당 조회를 시도할 레코드 수를 지정합니다. Type: int Default: 200 Min, Max: 1, 1000 |
| cursor optional | 다음 페이지 결과를 가져오기 위한 커서를 지정합니다. 자세한 내용은 Pagination을 참조하세요. Type: string Example: 8x7v00oow |
| sort_by optional | 지원되는 속성 기준으로 오름차순 또는 내림차순 정렬합니다. 자세한 내용은 Sorting을 참조하세요. Type: string Example: created_at-asc |
| with_deleted optional | 삭제된 결과를 포함합니다. Type: boolean Default: false Possible values: true, false |
| with_total_count optional | total_count 응답 속성을 포함합니다. Note: 이 매개변수와 cursor는 상호 배타적입니다. Note: total_count를 포함하는 요청은 더 낮은 요청 한도가 적용되며, 현재 15분당 200회로 설정되어 있습니다. Type: boolean Default: false Possible values: true, false |
GET https://ads-api.x.com/12/accounts/18ce54d4x5t/account_apps
Example Response
계정 내역
GET accounts/:account_id/account_history
요청에서 지정한entity_id에 적용된 변경 사항의 요약을 조회합니다.
참고: 이 엔드포인트는 현재 베타 단계이며 allowlist 등록이 필요합니다.
리소스 URL
https://ads-api.x.com/12/accounts/:account_id/account_history
매개변수
| Name | Description |
|---|---|
| account_id required | 대상 계정의 식별자입니다. Type: string Example: 18ce54d4x5t |
| count optional | 각 요청에서 조회할 레코드 수를 지정합니다. Type: int Default: 200 Min, Max: 1, 1000 |
| cursor optional | 다음 결과 페이지를 가져오기 위한 커서입니다. 자세한 내용은 Pagination을 참조하세요. Type: string Example: 8x7v00oow |
| entity_type required | 데이터를 조회할 엔터티 유형입니다. Type: enum Example: PROMOTED_TWEET Possible values: CAMPAIGN, LINE_ITEM, PROMOTED_TWEET, TARGETING_CRITERIA, PROMOTED_ACCOUNT |
| entity_id required | 데이터를 조회할 특정 엔터티의 id입니다. Type: string Example: 8u94t |
| start_time required | ISO 8601 형식으로 표현된 시작 시간으로 반환 데이터를 제한합니다. 참고: 반드시 정시(분 0, 초 0)로 표기해야 합니다. Type: string Example: 2017-05-19T07:00:00Z |
| end_time required | ISO 8601 형식으로 표현된 종료 시간으로 반환 데이터를 제한합니다. 참고: 반드시 정시(분 0, 초 0)로 표기해야 합니다. Type: string Example: 2017-05-26T07:00:00Z |
| user_id optional | 응답을 특정 사용자로 제한합니다. Type: long Example: 3271358660 |
GET https://ads-api.x.com/12/accounts/18ce54d4x5t/account_history?entity_type=CAMPAIGN&entity_id=fc3h5&count=1
예시 응답
광고주 비즈니스 카테고리
GET advertiser_business_categories
게시자에게 광고주의 브랜드를 설명할 수 있도록, 광고 그룹(line_items)에 사용할 유효한 광고주 비즈니스 categories를 요청합니다.
참고: 이러한 카테고리는 PREROLL_VIEWS 목표의 line_items에만 적용되며, 타기팅 기준에 사용되는 content_categories와는 별개입니다.
각 advertiser_business_categories는 IAB Categories 모음입니다. PREROLL_VIEWS 목표로 광고 그룹을 생성할 때는 광고 그룹에 하나 또는 두 개의 advertiser_business_categories를 설정해야 합니다. 이는 이 엔드포인트를 통해 제공되는 해당 iab_categories 집합으로 line item 엔드포인트의 categories 요청 매개변수 값을 설정하여 수행할 수 있습니다.
자세한 내용은 Video Views Preroll Objective Guide를 참조하세요.
Resource URL
https://ads-api.x.com/12/advertiser_business_categories
Parameters
요청 매개변수 없음
Example Request
GET https://ads-api.x.com/12/advertiser_business_categories
Example Response
오디언스 추정치
캠페인의 예상 잠재고객 규모를 확인합니다.
Content-Type: application/json 헤더가 포함된 JSON 본문을 가진 HTTP POST여야 합니다.
참고: 최소 한 가지 기본 타겟팅 기준을 지정해야 합니다. 모든 기본 타겟팅 기준 목록은 캠페인 타겟팅 페이지에서 확인할 수 있습니다.
리소스 URL
https://ads-api.x.com/12/accounts/:account_id/audience_estimate
매개변수
| Name | Description |
|---|---|
| account_id required | 활용 중인 계정의 식별자입니다. 리소스 경로에 포함되며, GET accounts를 제외한 대부분의 Advertiser API 요청에서 필요한 매개변수입니다. 지정한 계정은 인증된 사용자와 연결되어 있어야 합니다. Type: string Example: 18ce54d4x5t |
| targeting_criteria required | 타겟팅 기준 객체에 대한 모든 매개변수를 포함하는 JSON 객체입니다. 필수 및 선택 타겟팅 기준 매개변수 목록은 POST accounts/:account_id/targeting_criteria 엔드포인트에서 확인할 수 있습니다. |
| operator_type optional | 타겟팅 기준 간의 관계를 지정합니다. 예를 들어, 부정 타겟팅을 설정하려면 operator_type=NE를 사용하세요.Type: enum Possible values: EQ, NEDefault: EQ |
POST https://ads-api.x.com/12/accounts/18ce54d4x5t/audience_estimate
인증된 사용자 접근
GET accounts/:account_id/authenticated_user_access
지정된 광고 계정과 관련해 현재 인증된 사용자(access_token)의 권한을 가져옵니다. 이 권한은 ads.x.com에 표시되는 권한과 동일합니다. 가능한 값은 다음과 같습니다.ACCOUNT_ADMIN: 사용자를 추가/제거하고 설정을 변경할 수 있는 권한을 포함해, 캠페인을 수정하고 통계를 조회할 수 있는 전체 액세스 권한AD_MANAGER: 캠페인을 수정하고 통계를 조회할 수 있는 전체 액세스 권한이나, 사용자를 추가/제거하거나 설정을 변경할 수 없음CREATIVE_MANAGER: 크리에이티브를 수정하고 미리보기를 확인할 수 있으나, 캠페인을 생성하거나 수정할 수 없음CAMPAIGN_ANALYST: 캠페인과 통계를 조회할 수 있으나, 캠페인을 생성하거나 수정할 수 없음ANALYST(ads.x.com에서는 “Organic Analyst”): 유기적 분석 및 오디언스 인사이트를 조회할 수 있으나, 캠페인을 생성·수정하거나 조회할 수 없음PARTNER_AUDIENCE_MANAGER: 데이터 파트너 오디언스를 조회·수정할 수 있는 API 전용 액세스 권한이나, 캠페인·크리에이티브 또는 기타 오디언스 유형에는 액세스할 수 없음.
TWEET_COMPOSER 권한은 인증된 사용자가 광고주를 대신해 널캐스트(또는 “Promoted-only”) 트윗을 작성할 수 있음을 의미합니다. 이는 ACCOUNT_ADMIN, AD_MANAGER, CREATIVE_MANAGER 액세스를 보유한 사용자에게만 제공됩니다.
Resource URL
https://ads-api.x.com/12/accounts/:account_id/authenticated_user_access
Parameters
없음
Example Request
GET https://ads-api.x.com/12/accounts/18ce54d4x5t/authenticated_user_access
Example Response
입찰 규칙
GET bidding_rules
일부 또는 모든 통화에 대한 입찰 규칙을 조회합니다. 응답에는 최소 및 최대 CPE(참여당 비용) 입찰가가 표시됩니다. 입찰 규칙은 변경 빈도가 낮지만, 시스템에서 최소 월 1회 해당 엔드포인트에서 최신 정보를 가져오도록 권장합니다. Resource URLhttps://ads-api.x.com/12/bidding_rules
Parameters
| Name | Description |
|---|---|
| currency optional | 결과를 필터링할 통화 유형으로, ISO-4217 표준을 사용해 식별합니다. 세 글자의 문자열인 “USD” 또는 “EUR” 등입니다. 이 매개변수를 생략하면 모든 통화의 입찰 규칙을 조회합니다. Type: string Example: USD |
GET https://ads-api.x.com/12/bidding_rules?currency=USD
Example Response
캠페인
GET accounts/:account_id/campaigns
현재 계정과 연결된 일부 또는 모든 캠페인의 상세 정보를 조회합니다. Resource URLhttps://ads-api.x.com/12/accounts/:account_id/campaigns
Parameters
| Name | Description |
|---|---|
| account_id required | 사용 중인 계정의 식별자입니다. 리소스 경로에 포함되며, GET accounts를 제외한 모든 Advertiser API 요청에 일반적으로 필요한 매개변수입니다. 지정한 계정은 인증된 사용자와 연결되어 있어야 합니다. Type: string Example: 18ce54d4x5t |
| campaign_ids optional | 쉼표로 구분된 식별자 목록을 지정해 응답을 원하는 캠페인으로만 제한합니다. 최대 200개의 ID를 제공할 수 있습니다. Type: string Example: 8wku2 |
| count optional | 각 요청마다 조회할 레코드 수를 지정합니다. Type: int Default: 200 Min, Max: 1, 1000 |
| cursor optional | 다음 페이지 결과를 가져올 커서를 지정합니다. 자세한 내용은 Pagination을 참조하세요. Type: string Example: 8x7v00oow |
| funding_instrument_ids optional | 쉼표로 구분된 식별자 목록을 지정해 특정 자금 조달 수단에 속한 캠페인으로만 응답을 제한합니다. 최대 200개의 ID를 제공할 수 있습니다. Type: string Example: lygyi |
| q optional | name 기준으로 리소스 범위를 지정하는 선택적 쿼리입니다.Type: string Min, Max length: 1, 255 |
| sort_by optional | 지원되는 속성으로 오름차순 또는 내림차순 정렬합니다. 자세한 내용은 Sorting을 참조하세요. Type: string Example: created_at-asc |
| with_deleted optional | 삭제된 결과를 포함합니다. Type: boolean Default: false Possible values: true, false |
| with_draft optional | 초안 캠페인 결과를 포함합니다. Type: boolean Default: false Possible values: true, false |
| with_total_count optional | total_count 응답 속성을 포함합니다.Note: 이 매개변수와 cursor는 상호 배타적입니다.Note: total_count를 포함하는 요청에는 더 낮은 요청 한도가 적용되며, 현재 15분당 200으로 설정되어 있습니다.Type: boolean Default: false Possible values: true, false |
GET https://ads-api.x.com/12/accounts/18ce54d4x5t/campaigns?campaign_ids=8wku2
Example Response
GET accounts/:account_id/campaigns/:campaign_id
현재 계정에 연동된 특정 캠페인을 조회합니다. 리소스 URLhttps://ads-api.x.com/12/accounts/:account_id/campaigns/:campaign_id
매개변수
| Name | Description |
|---|---|
| account_id required | 사용 중인 계정의 식별자입니다. 리소스 경로에 포함되며, GET accounts를 제외한 모든 Advertiser API 요청에 일반적으로 필요한 매개변수입니다. 지정된 계정은 인증된 사용자와 연결되어 있어야 합니다. Type: string Example: 18ce54d4x5t |
| campaign_id required | 해당 요청에서 대상으로 삼는 캠페인의 참조입니다. Type: string Example: 8wku2 |
| with_deleted optional | 삭제된 결과를 포함합니다. Type: boolean Default: false Possible values: true, false |
GET https://ads-api.x.com/12/accounts/18ce54d4x5t/campaigns/8wku2
예시 응답
POST accounts/:account_id/campaigns
현재 계정에 연결된 새 캠페인을 생성합니다. 참고: 계정당 활성 캠페인의 기본 한도는 200개입니다. 비활성 캠페인 수에는 제한이 없습니다. 이 한도는 활성 캠페인 8,000개까지 상향할 수 있습니다. 상향 한도를 적용하려면 광고주가 자신의 X Account Manager에게 요청해야 합니다. Resource URLhttps://ads-api.x.com/12/accounts/:account_id/campaigns
Parameters
| Name | Description |
|---|---|
| account_id required | 사용 중인 계정의 식별자입니다. 리소스 경로에 포함되며 GET accounts를 제외한 모든 Advertiser API 요청에 일반적으로 필수 매개변수입니다. 지정된 계정은 인증된 사용자와 연동되어 있어야 합니다. Type: string Example: 18ce54d4x5t |
| funding_instrument_id required | 캠페인을 생성할 때 사용할 자금 수단의 식별자입니다. Type: string Example: lygyi |
| name required | 캠페인 이름입니다. 최대 길이: 255자. Type: string Example: demo |
| budget_optimization optional | 적용할 예산 최적화 유형을 선택합니다. Type: enum Default: CAMPAIGN Possible values: CAMPAIGN, LINE_ITEM |
| daily_budget_amount_local_micro sometimes required | 캠페인에 할당할 일일 예산 금액입니다. 지정된 자금 수단에 연결된 통화가 사용됩니다. USD의 경우 $5.50은 5,500,000으로 표시됩니다. 참고: total_budget_amount_local_micro보다 작거나 같아야 하며, 대부분의 자금 수단 유형에서 필수입니다.Type: long Example: 5500000 |
| entity_status optional | 캠페인 상태입니다. Type: enum Default: ACTIVE Possible values: ACTIVE, DRAFT, PAUSED |
| purchase_order_number optional | 예약(Booking) 참조 번호입니다. 송장 정산을 용이하게 하기 위해 이 필드를 사용하세요. 최대 길이: 50자. Type: string Example: D00805843 |
| standard_delivery optional | 표준 또는 가속 게재를 설정합니다. 표준 대비 가속 게재에 대한 자세한 내용은 Budget Pacing을 참조하세요. budget_optimization이 CAMPAIGN으로 설정된 경우에만 사용 가능합니다.Type: boolean Default: true Possible values: true, false |
| total_budget_amount_local_micro optional | 캠페인에 할당할 총 예산 금액입니다. 지정된 자금 수단에 연결된 통화가 사용됩니다. USD의 경우 $37.50은 37,500,000으로 표시됩니다. Type: long Example: 37500000 |
POST https://ads-api.x.com/12/accounts/18ce54d4x5t/campaigns?funding_instrument_id=lygyi&name=demo&daily_budget_amount_local_micro=140000000&entity_status=PAUSED&budget_optimization=CAMPIAGN&standard_delivery=false
Example Response
POST batch/accounts/:account_id/campaigns
단일 요청으로 새로운 캠페인을 일괄 생성할 수 있습니다. 일괄 요청- 현재 최대 배치 크기는 40개입니다.
- 모든 매개변수는 요청 본문으로 전송되며
Content-Type은application/json이어야 합니다. - 일괄 요청은 하나의 그룹으로 함께 성공하거나 실패하며, 성공 및 오류 응답 모두에서 초기 요청의 항목 순서를 유지합니다.
- 요청 수준 오류(예: 최대 배치 크기 초과)는 응답의
errors객체에 표시됩니다. - 항목 수준 오류(예: 필수 캠페인 매개변수 누락)는 응답의
operation_errors객체에 표시됩니다.
https://ads-api.x.com/12/batch/accounts/:account_id/campaigns
매개변수
| Name | Description |
|---|---|
| operation_type required | 항목별로 수행되는 작업 유형입니다. Type: enum Possible values: Create, Delete, Update |
| params required | 캠페인 객체의 모든 매개변수를 포함하는 JSON 객체입니다. 필수 및 선택 캠페인 매개변수 목록은 여기를 참조하세요. |
POST 'Content-Type: application/json' https://ads-api.x.com/12/batch/accounts/18ce54d4x5t/campaigns
PUT accounts/:account_id/campaigns/:campaign_id
현재 계정과 연결된 지정된 캠페인을 업데이트합니다. 리소스 URLhttps://ads-api.x.com/12/accounts/:account_id/campaigns/:campaign_id
매개변수
| Name | Description |
|---|---|
| account_id required | 사용 중인 계정의 식별자입니다. 리소스 경로에 포함되며, GET accounts를 제외한 모든 Advertiser API 요청에서 일반적으로 필수 매개변수입니다. 지정된 계정은 인증된 사용자와 연결되어 있어야 합니다. Type: string Example: 18ce54d4x5t |
| campaign_id required | 요청에서 작업 중인 캠페인에 대한 참조입니다. Type: string Example: 8wku2 |
| budget_optimization optional | 적용할 예산 최적화 유형을 선택합니다. Type: enum Default: CAMPAIGN Possible values: CAMPAIGN, LINE_ITEM |
| daily_budget_amount_local_micro optional | 캠페인에 할당할 일일 예산 금액입니다. 지정된 자금 조달 수단에 연결된 통화를 사용합니다. USD의 경우 $5.50은 5,500,000으로 표시됩니다. 값을 제공하지 않으면 캠페인은 총 예산과 캠페인 운영 기간에 따라 균등하게 집행됩니다. 참고: total_budget_amount_local_micro보다 작거나 같아야 합니다.Type: long Example: 5500000 |
| entity_status optional | 캠페인의 상태입니다. Type: enum Possible values: ACTIVE, PAUSED |
| name optional | 캠페인 이름입니다. 최대 길이: 255자. Type: string Example: demo |
| purchase_order_number optional | 예약 참조 번호입니다. 송장 대조를 돕기 위해 이 필드를 사용하세요. 최대 길이: 50자. Type: string Example: D00805843 |
| standard_delivery optional | 표준 또는 가속 게재를 사용합니다. 표준과 가속 게재에 대한 자세한 내용은 Budget Pacing을 참고하세요. budget_optimization이 CAMPAIGN으로 설정된 경우에만 사용 가능합니다.Type: boolean Default: true Possible values: true, false |
| total_budget_amount_local_micro optional | 캠페인에 할당할 총 예산 금액입니다. 지정된 자금 조달 수단에 연결된 통화를 사용합니다. USD의 경우 $37.50은 37,500,000으로 표시됩니다. Type: long Example: 140000000 |
PUT https://ads-api.x.com/12/accounts/18ce54d4x5t/campaigns/8wku2?total_budget_amount_local_micro=140000000
예시 응답
DELETE accounts/:account_id/campaigns/:campaign_id
현재 계정에 속한 지정된 캠페인을 삭제합니다. 참고: 캠페인 삭제는 되돌릴 수 없으며 이후 해당 리소스를 다시 삭제하려는 시도는 HTTP 404를 반환합니다. Resource URLhttps://ads-api.x.com/12/accounts/:account_id/campaigns/:campaign_id
Parameters
| Name | Description |
|---|---|
| account_id required | 사용 중인 계정의 식별자입니다. 리소스 경로에 포함되며, GET accounts를 제외한 모든 Advertiser API 요청에서 일반적으로 필수 매개변수입니다. 지정한 계정은 인증된 사용자와 연결되어 있어야 합니다. Type: string Example: 18ce54d4x5t |
| campaign_id required | 요청에서 대상으로 하는 캠페인에 대한 참조입니다. Type: string Example: 8yn7m |
DELETE https://ads-api.x.com/12/accounts/18ce54d4x5t/campaigns/8yn7m
Example Response
콘텐츠 범주
GET content_categories
라인 아이템의targeting_criteria로 설정할 수 있는 유효한 콘텐츠 categories를 요청합니다.
각 content_category는 하나 이상의 IAB 카테고리에 매핑됩니다. 배치 targeting_critera 엔드포인트에서 targeting_type을 IAB_CATEGORY로 설정하고, content_categories 요청에서 반환된 해당 iab_categories 집합을 포함하면 됩니다. 이를 수행하지 않으면 검증 오류가 발생합니다.
각 콘텐츠 카테고리에 대한 퍼블리셔 상세 정보는 GET publishers 엔드포인트를 통해 조회할 수 있습니다.
자세한 내용은 Video Views Pre-roll Objective Guide를 참고하세요.
Resource URL
https://ads-api.x.com/12/content_categories
Parameters
요청 파라미터 없음
Example Request
GET https://ads-api.x.com/12/content_categories
Example Response
엄선된 카테고리
GET accounts/:account_id/curated_categories
지정한country_codes에 대해 사용 가능한 Curated Categories 목록을 조회합니다.
각 curated_category는 응답의 country_codes에 명시된 특정 국가에서만 제공됩니다.
자세한 내용은 Video Views Pre-roll Objective Guide를 참고하세요.
Resource URL
https://ads-api.x.com/12/accounts/:account_id/curated_categories
Parameters
| Name | Description |
|---|---|
| account_id required | 사용 중인 계정의 식별자입니다. 리소스 경로에 포함되며, GET accounts를 제외한 모든 Advertiser API 요청에서 일반적으로 필요한 매개변수입니다. 지정한 계정은 인증된 사용자와 연결되어 있어야 합니다. Type: string Example: 18ce54d4x5t |
| country_codes required | 쉼표로 구분된 두 글자 ISO 국가 코드를 지정하여 응답을 원하는 국가로만 제한합니다. 최대 200개의 ID를 제공할 수 있습니다. Type: string Example: US |
| cursor optional | 다음 결과 페이지를 가져오기 위한 커서를 지정합니다. 자세한 내용은 Pagination을 참조하세요. Type: string Example: 8x7v00oow |
GET https://ads-api.x.com/12/accounts/18ce54d4x5t/curated_categories?country_codes=US
Example Response
GET accounts/:account_id/curated_categories/:curated_category_id
특정curated_category_id의 세부 정보를 조회합니다.
각 curated_category는 응답의 country_codes에 명시된 특정 국가에서만 제공됩니다.
Resource URL
https://ads-api.x.com/12/accounts/:account_id/curated_categories/:curated_category_id
Parameters
| Name | Description |
|---|---|
| account_id required | 사용 중인 계정의 식별자입니다. 리소스 경로에 포함되며, GET accounts를 제외한 모든 Advertiser API 요청에서 일반적으로 필수 매개변수입니다. 지정한 계정은 인증된 사용자와 연결되어 있어야 합니다. Type: string Example: 18ce54d4x5t |
| curated_category_id required | 요청에서 사용 중인 Curated Category에 대한 참조입니다. Type: string Example: 9ddrgesiap6o |
GET https://ads-api.x.com/12/accounts/18ce54d4x5t/curated_categories/9ddrgesiap6o
Example Response
기능
GET accounts/:account_id/features
이 광고 계정에 부여되어 접근 가능한 기능들의 컬렉션을 조회합니다. 기능은 설명적인 기능 키로 표시되며, 베타 또는 기타 제한적 릴리스로 도입되어 Ads API에서 사용 가능한 경우에만 이 엔드포인트에서 노출됩니다. 이 기준을 충족하지 않는 기능은 이 엔드포인트에서 노출되지 않습니다. 참고: 이 엔드포인트는 클라이언트의 베타 릴리스 접근성을 더 투명하게 보여 줌으로써 Ads API 생태계 개발을 지원합니다. API 개발자는 광고주를 대신하여 기능 접근을 요청할 수 없습니다. 이러한 요청은 광고주가 자신들의 X 계정 매니저에게만 할 수 있습니다. 리소스 URLhttps://ads-api.x.com/12/accounts/:account_id/features
매개변수
| Name | Description |
|---|---|
| account_id required | 사용 중인 계정의 식별자입니다. 리소스 경로에 포함되며 일반적으로 GET accounts를 제외한 모든 Advertiser API 요청에 필요한 매개변수입니다. 지정된 계정은 인증된 사용자와 연계되어 있어야 합니다. Type: string Example: 18ce54d4x5t |
| feature_keys optional | 특정 기능 키를 조회할 수 있는 선택적 매개변수입니다. 요청에는 쉼표로 구분된 여러 키를 포함할 수 있습니다. 참고: 이 계정에서 접근 가능한 기능만 응답에 포함됩니다. Type: enum Possible values: REACH_AND_FREQUENCY_ANALYTICS, REACH_FREQUENCY_CAP, WEBSITE_CLICKS_CPM_BILLING |
GET https://ads-api.x.com/12/accounts/18ce54d4x5t/features
응답 예시
POST accounts/:account_id/features
SANDBOX 전용 Sandbox 계정에 기능을 추가합니다. 최신 계정 기능 목록은 GET accounts/:account_id/features 엔드포인트에서 조회할 수 있습니다. 리소스 URLhttps://ads-api-sandbox.x.com/12/accounts/:account_id/features
매개변수
| Name | Description |
|---|---|
| account_id required | 사용 중인 계정의 식별자입니다. 리소스 경로에 포함되며, GET accounts를 제외한 모든 Advertiser API 요청에서 일반적으로 필수 매개변수입니다. 지정한 계정은 인증된 사용자와 연결되어 있어야 합니다. Type: string Example: gq180y |
| feature_keys required | 계정에 추가할 계정 기능의 쉼표로 구분된 목록입니다. Type: enum Possible values: AGE_TARGETING, ALLOW_SKIPPABLE_VIDEOS_FOR_PREROLL_VIEWS_OBJECTIVE, AWARENESS_OBJECTIVE, BRAND_TPN, CHARGE_FOR_GOOD_CLICK, CONVERSATION_CARD, CONVERSATION_CARD_FOUR_OPTIONS, CONVERSATION_CARD_UNLOCK, CPI_CHARGING, DIRECT_MESSAGE_CARD, DR_TAP, ENGAGER_RETARGETING, EVENT_TARGETING, INSTALLED_APP_CATEGORY_TARGETING, MOBILE_CONVERSION_TRANSACTION_VALUE, OPTIMIZED_ACTION_BIDDING, REACH_AND_FREQUENCY_ANALYTICS, REACH_FREQUENCY_CAP, VALIDATED_AGE_TARGETING, VIDEO_VIEWS_MIDROLL_OBJECTIVE, PREROLL_VIEWS_OBJECTIVE, VIDEO_APP_DOWNLOAD_CARD |
POST https://ads-api-sandbox.x.com/12/accounts/gq180y/features?feature_keys=VALIDATED_AGE_TARGETING
예시 응답
DELETE accounts/:account_id/features
SANDBOX 전용 Sandbox 계정에서 기능을 제거합니다. 최신 계정 기능 목록은 GET accounts/:account_id/features 엔드포인트를 통해 조회할 수 있습니다. 리소스 URLhttps://ads-api-sandbox.x.com/12/accounts/:account_id/features
매개변수
| 이름 | 설명 |
|---|---|
| account_id 필수 | 사용 중인 계정의 식별자입니다. 리소스 경로에 포함되며 GET accounts를 제외한 모든 Advertiser API 요청에서 일반적으로 필수 매개변수입니다. 지정한 계정은 인증된 사용자와 연결되어 있어야 합니다. 유형: string 예: gq180y |
| feature_keys 필수 | 계정에서 제거할 계정 기능의 쉼표로 구분된 목록입니다. 유형: enum 가능한 값: AGE_TARGETING, ALLOW_SKIPPABLE_VIDEOS_FOR_PREROLL_VIEWS_OBJECTIVE, AWARENESS_OBJECTIVE, BRAND_TPN, CHARGE_FOR_GOOD_CLICK, CONVERSATION_CARD, CONVERSATION_CARD_FOUR_OPTIONS, CONVERSATION_CARD_UNLOCK, CPI_CHARGING, DIRECT_MESSAGE_CARD, DR_TAP, ENGAGER_RETARGETING, EVENT_TARGETING, INSTALLED_APP_CATEGORY_TARGETING, MOBILE_CONVERSION_TRANSACTION_VALUE, OPTIMIZED_ACTION_BIDDING, REACH_AND_FREQUENCY_ANALYTICS, REACH_FREQUENCY_CAP, VALIDATED_AGE_TARGETING, VIDEO_VIEWS_MIDROLL_OBJECTIVE, PREROLL_VIEWS_OBJECTIVE, VIDEO_APP_DOWNLOAD_CARD |
DELETE https://ads-api-sandbox.x.com/12/accounts/gq180y/features?feature_keys=PREROLL_VIEWS_OBJECTIVE
응답 예시
자금 조달 수단
GET accounts/:account_id/funding_instruments
현재 계정에 연동된 일부 또는 모든 결제 수단의 세부 정보를 조회합니다. Resource URLhttps://ads-api.x.com/12/accounts/:account_id/funding_instruments
Parameters
| Name | Description |
|---|---|
| account_id required | 레버리지 계정의 식별자입니다. 리소스 경로에 포함되며, GET accounts를 제외한 모든 Advertiser API 요청에서 일반적으로 필요한 매개변수입니다. 지정된 계정은 인증된 사용자와 연동되어 있어야 합니다. Type: string Example: 18ce54d4x5t |
| count optional | 요청당 조회할 레코드 수를 지정합니다. Type: int Default: 200 Min, Max: 1, 1000 |
| cursor optional | 다음 결과 페이지를 가져오기 위한 커서를 지정합니다. 자세한 내용은 Pagination을 참조하세요. Type: string Example: 8x7v00oow |
| funding_instrument_ids optional | 쉼표로 구분한 식별자 목록을 지정하여 원하는 결제 수단만으로 응답을 한정합니다. 최대 200개의 ID를 제공할 수 있습니다. Type: string Example: lygyi |
| sort_by optional | 지원되는 속성을 기준으로 오름차순 또는 내림차순으로 정렬합니다. 자세한 내용은 Sorting을 참조하세요. Type: string Example: created_at-asc |
| with_deleted optional | 삭제된 결과를 포함합니다. Type: boolean Default: false Possible values: true, false |
| with_total_count optional | total_count 응답 속성을 포함합니다.Note: 이 매개변수와 cursor는 상호 배타적입니다.Note: total_count를 포함하는 요청에는 더 낮은 요청 한도가 적용되며, 현재 15분당 200입니다.Type: boolean Default: false Possible values: true, false |
GET https://ads-api.x.com/12/accounts/18ce54d4x5t/funding_instruments
Example Response
GET accounts/:account_id/funding_instruments/:funding_instrument_id
현재 계정과 연결된 특정 자금 조달 수단을 조회합니다. 리소스 URLhttps://ads-api.x.com/12/accounts/:account_id/funding_instruments/:id
매개변수
| 이름 | 설명 |
|---|---|
| account_id 필수 | 레버리지 계정의 식별자입니다. 리소스 경로에 포함되며 GET accounts를 제외한 모든 Advertiser API 요청에서 일반적으로 필수입니다. 지정한 계정은 인증된 사용자와 연결되어 있어야 합니다. 유형: string 예시: 18ce54d4x5t |
| funding_instrument_id 필수 | 요청에서 사용 중인 자금 조달 수단을 가리키는 참조입니다. 유형: string 예시: lygyi |
| with_deleted 옵션 | 삭제된 결과를 포함합니다. 유형: boolean 기본값: false 가능한 값: true, false |
GET https://ads-api.x.com/12/accounts/18ce54d4x5t/funding_instruments/lygyi
응답 예시
POST accounts/:account_id/funding_instruments
샌드박스 전용 샌드박스 환경에서 자금조달 수단을 생성합니다. 샌드박스 자금조달 수단을 사용하는 동안 비용이 발생할 위험은 없습니다. 리소스 URLhttps://ads-api-sandbox.x.com/12/accounts/:account_id/funding_instruments
매개변수
| 이름 | 설명 |
|---|---|
| account_id 필수 | 레버리지 계정의 식별자입니다. 리소스 경로에 포함되며, GET accounts를 제외한 대부분의 Advertiser API 요청에서 일반적으로 필수 매개변수입니다. 지정한 계정은 인증된 사용자와 연결되어 있어야 합니다. 유형: string 예시: gq1844 |
| currency 필수 | ISO-4217 형식의 통화입니다. 유형: string 예시: USD |
| start_time 필수 | 자금조달 수단이 활성화되어 사용 가능해지는 날짜로, ISO 8601 형식으로 표현됩니다. 유형: string 예시: 2017-05-19T07:00:00Z |
| type 필수 | 생성할 자금조달 수단의 유형입니다. 유형: enum 가능한 값: AGENCY_CREDIT_LINE, CREDIT_CARD, CREDIT_LINE, INSERTION_ORDER, PARTNER_MANAGED |
| end_time 상황에 따라 필수 | 자금조달 수단이 비활성화되는 날짜로, ISO 8601 형식으로 표현됩니다. 유형: string 예시: 2017-05-26T07:00:00Z |
| credit_limit_local_micro 선택 사항 | 이 자금조달 수단에 대해 사용 가능한 총 신용한도입니다. 참고: 일부 자금조달 수단 유형에만 적용됩니다. 유형: long 예시: 37500000 |
| funded_amount_local_micro 선택 사항 | 이 자금조달 수단에 할당된 총 예산 금액입니다. 참고: 일부 자금조달 수단 유형에만 적용됩니다. 유형: long 예시: 37500000 |
POST https://ads-api-sandbox.x.com/12/accounts/gq1844/funding_instruments?currency=USD&start_time=2017-07-10T00:00:00Z&type=INSERTION_ORDER&end_time=2018-01-10T00:00:00Z&funded_amount_local_micro=140000000000
응답 예시
DELETE accounts/:account_id/funding_instruments/:funding_instrument_id
SANDBOX 전용 샌드박스 환경에서 자금 조달 수단을 삭제합니다. 리소스 URLhttps://ads-api-sandbox.x.com/12/accounts/:account_id/funding_instruments/:funding_instrument_id
매개변수
| 이름 | 설명 |
|---|---|
| account_id 필수 | 레버리지 계정의 식별자입니다. 리소스 경로에 포함되며, GET accounts를 제외한 모든 Advertiser API 요청에서 일반적으로 필수 매개변수입니다. 지정한 계정은 인증된 사용자와 연결되어 있어야 합니다. 유형: string 예: gq1844 |
| funding_instrument_id 필수 | 요청에서 대상으로 삼는 자금 조달 수단의 참조입니다. 유형: string 예: hxt82 |
DELETE https://ads-api-sandbox.x.com/12/accounts/gq1844/funding_instruments/hxt82
응답 예시
IAB 분류
GET iab_categories
광고 그룹(line_items)에서 사용할 수 있는 유효한 앱 categories를 요청합니다.
리소스 URL
https://ads-api.x.com/12/iab_categories
매개변수
| 이름 | 설명 |
|---|---|
| count 선택 사항 | 각 요청당 조회할 레코드 수를 지정합니다. 유형: int 기본값: 200 최소, 최대: 1, 1000 |
| cursor 선택 사항 | 다음 페이지의 카테고리를 가져오기 위한 커서를 지정합니다. 자세한 내용은 페이지 매김을 참조하세요. 유형: string 예시: gc-ddf4a |
| with_total_count 선택 사항 | 응답에 total_count 속성을 포함합니다.참고: 이 매개변수와 cursor는 상호 배타적입니다.참고: total_count를 포함하는 요청은 더 낮은 요청 한도가 적용되며, 현재 15분당 200으로 설정되어 있습니다.유형: boolean 기본값: false 가능한 값: true, false |
GET https://ads-api.x.com/12/iab_categories?count=2
응답 예시
라인 아이템(Line Items)
GET accounts/:account_id/line_items
현재 계정과 연결된 일부 또는 모든 라인 아이템의 상세 정보를 조회합니다. Resource URLhttps://ads-api.x.com/12/accounts/:account_id/line_items
Parameters
| Name | Description |
|---|---|
| account_id required | 사용 중인 계정의 식별자입니다. 리소스 경로에 포함되며 GET accounts를 제외한 모든 Advertiser API 요청에서 일반적으로 필수 매개변수입니다. 지정된 계정은 인증된 사용자와 연계되어 있어야 합니다. Type: string Example: 18ce54d4x5t |
| campaign_ids optional | 쉼표로 구분된 식별자 목록을 지정하여 특정 캠페인에 속한 라인 아이템으로만 응답을 제한합니다. 최대 200개의 ID를 제공할 수 있습니다. Type: string Example: 8gdx6 |
| count optional | 각 요청에서 조회할 레코드 수를 지정합니다. Type: int Default: 200 Min, Max: 1, 1000 |
| cursor optional | 다음 결과 페이지를 가져오기 위한 커서를 지정합니다. 자세한 내용은 Pagination을 참조하세요. Type: string Example: 8x7v00oow |
| funding_instrument_ids optional | 쉼표로 구분된 식별자 목록을 지정하여 특정 자금 수단에 속한 라인 아이템으로만 응답을 제한합니다. 최대 200개의 ID를 제공할 수 있습니다. Type: string Example: lygyi |
| line_item_ids optional | 쉼표로 구분된 식별자 목록을 지정하여 원하는 라인 아이템으로만 응답을 제한합니다. 최대 200개의 ID를 제공할 수 있습니다. Type: string Example: 8v7jo |
| q optional | name을 기준으로 리소스를 범위 지정하기 위한 선택적 쿼리입니다.Type: string Min, Max length: 1, 255 |
| sort_by optional | 지원되는 속성으로 오름차순 또는 내림차순 정렬합니다. 자세한 내용은 Sorting을 참조하세요. Type: string Example: created_at-asc |
| with_deleted optional | 삭제된 결과를 포함합니다. Type: boolean Default: false Possible values: true, false |
| with_draft optional | 초안 캠페인의 결과를 포함합니다. Type: boolean Default: false Possible values: true, false |
| with_total_count optional | total_count 응답 속성을 포함합니다.Note: 이 매개변수와 cursor는 상호 배타적입니다.Note: total_count를 포함하는 요청은 더 낮은 요청 한도가 적용되며, 현재 15분당 200으로 설정되어 있습니다.Type: boolean Default: false Possible values: true, false |
GET https://ads-api.x.com/12/accounts/18ce54d4x5t/line_items?line_item_ids=itttx
Example Response
GET accounts/:account_id/line_items/:line_item_id
현재 계정과 연결된 특정 라인 아이템을 조회합니다. 리소스 URLhttps://ads-api.x.com/12/accounts/:account_id/line_items/:line_item_id
매개변수
| 이름 | 설명 |
|---|---|
| account_id required | 사용 중인 계정의 식별자입니다. 리소스 경로에 포함되며, GET accounts를 제외한 모든 Advertiser API 요청에서 일반적으로 필수 매개변수입니다. 지정된 계정은 인증된 사용자와 연결되어 있어야 합니다. 유형: string 예시: 18ce54d4x5t |
| line_item_id required | 요청에서 대상으로 하는 라인 아이템의 참조입니다. 유형: string 예시: 8v7jo |
| with_deleted optional | 삭제된 결과를 포함합니다. 유형: boolean 기본값: false 가능한 값: true, false |
GET https://ads-api.x.com/12/accounts/18ce54d4x5t/line_items/itttx
예시 응답
POST accounts/:account_id/line_items
현재 계정의 지정된 캠페인에 연결된 라인 아이템을 생성합니다. 하나의 캠페인 내 모든 라인 아이템은 동일한product_type 및 objective여야 합니다.
PROMOTED_ACCOUNT 제품 유형을 사용할 때 line_item에 트윗을 연결하면 표준 PROMOTED_ACCOUNT 게재 위치에 더해 모바일 타임라인 게재가 추가됩니다.
android_app_store_identifier 또는 ios_app_store_identifier를 설정하면 홍보 중인 모바일 앱과 일치하는 라인 아이템의 타기팅 기준이 자동으로 추가됩니다. 예를 들어 ios_app_store_identifier를 전달하면 iOS에 대한 PLATFORM 타기팅 기준이 추가됩니다.
참고: 캠페인당 라인 아이템은 100개로 제한되며, 모든 캠페인 전체에서 활성 라인 아이템은 256개로 제한됩니다.
Resource URL
https://ads-api.x.com/12/accounts/:account_id/line_items
Parameters
| 이름 | 설명 |
|---|---|
| account_id 필수 | 사용할 계정의 식별자입니다. 리소스 경로 내에 표시되며 일반적으로 GET accounts를 제외한 모든 광고주 API 요청에 필수 매개변수입니다. 지정된 계정은 인증된 사용자와 연결되어 있어야 합니다. 유형: string 예시: 18ce54d4x5t |
| campaign_id 필수 | 라인 아이템을 생성할 캠페인의 식별자입니다. 유형: string 예시: 8slvg |
| end_time 필수 | 라인 아이템의 게재가 중단될 시간으로, ISO 8601 형식으로 표현됩니다. 유형: string 예시: 2017-10-05T00:00:00Z |
| objective 필수 | 이 라인 아이템의 캠페인 목표입니다. 유형: enum 가능한 값: APP_ENGAGEMENTS, APP_INSTALLS, REACH, FOLLOWERS, ENGAGEMENTS, VIDEO_VIEWS, PREROLL_VIEWS, WEBSITE_CLICKS |
| placements 필수 | 이 라인 아이템이 표시될 게재 위치입니다. 쉼표로 구분된 게재 위치 값 목록을 지정하십시오. 유형: enum 가능한 값: ALL_ON_TWITTER, PUBLISHER_NETWORK, TAP_BANNER, TAP_FULL, TAP_FULL_LANDSCAPE, TAP_NATIVE, TAP_MRECT,TWITTER_PROFILE, TWITTER_REPLIES, TWITTER_SEARCH, TWITTER_TIMELINE |
| product_type 필수 | 이 라인 아이템에 포함될 프로모션 제품의 유형입니다. 유형: enum 가능한 값: MEDIA, PROMOTED_ACCOUNT, PROMOTED_TWEETS |
| start_time 필수 | 라인 아이템의 게재가 시작될 시간으로, ISO 8601 형식으로 표현됩니다. 유형: string 예시: 2017-07-05T00:00:00Z |
| advertiser_domain 경우에 따라 필수 | 프로토콜 지정 없이 이 광고주의 웹사이트 도메인입니다. 참고: 라인 아이템의 게재 위치가 PUBLISHER_NETWORK로 설정된 경우 필수입니다.유형: string 예시: x.com |
| android_app_store_identifier 경우에 따라 필수 | 프로모션 애플리케이션의 Google App Store 식별자입니다. 참고: APP_INSTALLS 및 APP_ENGAGEMENTS 목표는 android_app_store_identifier 또는 ios_app_store_identifier 중 하나 이상의 앱 스토어 식별자 설정이 필요합니다.유형: string 예시: com.twitter.android |
| bid_amount_local_micro 경우에 따라 필수 | 이 라인 아이템과 연결될 입찰 금액입니다. 지정된 펀딩 수단과 연결된 통화가 사용됩니다. USD의 경우 $5.50은 5500000으로 표현됩니다. 참고: bid_strategy가 MAX 또는 TARGET으로 설정된 경우 필수입니다.참고: 0보다 큰 값만 허용됩니다. 유형: long 예시: 5500000 |
| categories 경우에 따라 필수 | 이 광고주의 관련 IAB 카테고리입니다. GET iab_categories를 참조하십시오. 참고: 라인 아이템의 게재 위치가 PUBLISHER_NETWORK로 설정된 경우 필수입니다.유형: string 예시: IAB3-1 |
| ios_app_store_identifier 경우에 따라 필수 | 프로모션 애플리케이션의 Apple App Store 식별자 중 숫자 부분입니다. 참고: APP_INSTALLS 및 APP_ENGAGEMENTS 목표는 android_app_store_identifier 또는 ios_app_store_identifier 중 하나 이상의 앱 스토어 식별자 설정이 필요합니다.유형: string 예시: 333903271 |
| primary_web_event_tag 경우에 따라 필수 | 기본 웹 이벤트 태그의 식별자입니다. 이 라인 아이템과 관련된 캠페인의 참여를 보다 정확하게 추적할 수 있습니다. 참고: 라인 아이템의 목표가 WEBSITE_CONVERSIONS로 설정된 경우 필수입니다.유형: string 예시: nvo4z |
| advertiser_user_id 선택 사항 | PREROLL_VIEWS 광고를 프로모션하는 핸들의 X 사용자 식별자입니다. 특정 클라이언트 애플리케이션만 이 매개변수를 사용할 수 있습니다.유형: string 예시: 312226591 |
| audience_expansion 선택 사항 | 이미 타겟팅된 사용자와 유사한 사용자를 타겟팅하여 캠페인의 도달 범위를 확장하는 데 사용됩니다. 참고: 기본적으로 확장이 적용되지 않습니다. 유형: enum 가능한 값: BROAD, DEFINED, EXPANDED |
| bid_strategy 선택 사항 | 입찰 메커니즘입니다.AUTO는 일일 예산 및 캠페인 게재 기간을 기반으로 입찰을 자동으로 최적화합니다.MAX는 허용 가능한 최대 입찰가를 설정하며 목표가 REACH 또는 FOLLOWERS로 설정된 경우 사용할 수 없습니다.TARGET은 일일 입찰 평균을 지정된 bid_amount_local_micro의 20% 이내로 유지하려고 시도하며 목표가 REACH, FOLLOWERS 또는 WEBSITE_CLICKS로 설정된 경우 사용할 수 있습니다.참고: AUTO로 설정된 경우 bid_amount_local_micro는 무시됩니다.참고: 목표에 따라 기본값이 설정됩니다. 유형: enum 가능한 값: AUTO, MAX, TARGET |
| duration_in_days 선택 사항 | frequency_cap이 달성되는 기간입니다.유형: int 가능한 값: 1, 7, 30 |
| entity_status 선택 사항 | 라인 아이템 상태입니다. 유형: enum 기본값: ACTIVE 가능한 값: ACTIVE, DRAFT, PAUSED |
| frequency_cap 선택 사항 | 사용자에게 광고가 전달될 수 있는 최대 횟수입니다. 참고: REACH, ENGAGEMENTS, VIDEO_VIEWS 및 PREROLL_VIEWS 목표에만 지원됩니다.유형: int 예시: 5 |
| goal 선택 사항 | 이 라인 아이템과 함께 사용할 최적화 설정입니다.APP_PURCHASES 옵션은 APP_INSTALL에 사용할 수 있습니다. APP_CLICKS 및 APP_INSTALLS 옵션은 APP_INSTALL 및 APP_ENGAGEMENTS 목표 모두에 사용할 수 있으며 지원되는 MACT 파트너 사용이 필요할 수 있습니다.SITE_VISITS 옵션은 WEBSITE_CLICKS 목표에만 사용할 수 있습니다.참고: 목표에 따라 기본값이 설정됩니다. 유형: enum 가능한 값: APP_CLICKS, APP_INSTALLS, APP_PURCHASES,ENGAGEMENT, FOLLOWERS, LINK_CLICKS, MAX_REACH, PREROLL, PREROLL_STARTS, REACH_WITH_ENGAGEMENT, SITE_VISITS, VIDEO_VIEW, VIEW_3S_100PCT, VIEW_6S, VIEW_15S, WEBSITE_CONVERSIONS |
| name 선택 사항 | 라인 아이템의 이름입니다. 유형: string 예시: demo최소, 최대 길이: 1, 255 |
| pay_by 선택 사항 | 이 라인 아이템에 대해 과금할 단위입니다. 이 설정은 APP_INSTALLS 목표를 사용하는 라인 아이템에 대해서만 수정할 수 있습니다.참고: 기본 pay_by는 캠페인 목표 및 라인 아이템의 입찰 단위에 따라 자동으로 설정됩니다.APP_INSTALLS 목표는 APP_CLICK 및 IMPRESSION 값을 모두 지원합니다. IMPRESSION이 기본값입니다.LINK_CLICKS 목표는 LINK_CLICK 및 IMPRESSION 값을 모두 지원합니다. IMPRESSION이 기본값이지만 bid_strategy에 TARGET을 설정할 때는 지원되지 않습니다.SITE_VISITS 목표는 IMPRESSION 값을 지원합니다.유형: enum 가능한 값: APP_CLICK, IMPRESSION, LINK_CLICK |
| standard_delivery 선택 사항 | 표준 또는 가속 게재를 활성화합니다. 표준 게재와 가속 게재에 대한 자세한 내용은 예산 페이싱을 참조하세요. 상위 캠페인의 budget_optimization이 LINE_ITEM으로 설정된 경우에만 사용할 수 있습니다유형: boolean 기본값: true 가능한 값: true, false |
| total_budget_amount_local_micro 선택 사항 | 라인 아이템에 할당할 총 예산 금액입니다. 지정된 펀딩 인스트루먼트와 연결된 통화가 사용됩니다. USD의 경우 $37.50은 37500000으로 표시됩니다. 유형: long 예시: 37500000 |
| daily_budget_amount_local_micro 경우에 따라 필수 | 캠페인에 할당할 일일 예산 금액입니다. 지정된 펀딩 인스트루먼트와 연결된 통화가 사용됩니다. USD의 경우 $5.50은 5500000으로 표시됩니다. 제공되지 않은 경우 캠페인은 총 예산과 캠페인 게재 기간을 기준으로 균등하게 지출됩니다. 상위 캠페인의 budget_optimization이 LINE_ITEM으로 설정된 경우에만 사용할 수 있습니다참고: 이 값은 total_budget_amount_local_micro보다 작거나 같아야 합니다.유형: long 예시: 5500000 |
POST https://ads-api.x.com/12/accounts/18ce54d4x5t/line_items?campaign_id=hwtq0&objective=ENGAGEMENTS&product_type=PROMOTED_TWEETS&placements=ALL_ON_TWITTER&bid_amount_local_micro=3210000&entity_status=PAUSED&daily_budget_amount_local_micro=1000000&start_time=2022-06-15
예제 응답
POST batch/accounts/:account_id/line_items
단일 요청으로 새로운 라인 아이템을 일괄 생성할 수 있습니다. 배치 요청- 현재 최대 배치 크기는 40입니다.
- 모든 매개변수는 요청 본문으로 전송되며
Content-Type은application/json이어야 합니다. - 배치 요청은 그룹 단위로 함께 성공하거나 실패하며, 오류와 성공을 포함한 모든 API 응답은 초기 요청의 아이템 순서를 그대로 유지합니다.
- 요청 수준 오류(예: 최대 배치 크기 초과)는 응답의
errors객체에 표시됩니다. - 아이템 수준 오류(예: 필수 라인 아이템 매개변수 누락)는 응답의
operation_errors객체에 표시됩니다.
https://ads-api.x.com/12/batch/accounts/:account_id/line_items
매개변수
| Name | Description |
|---|---|
| operation_type required | 아이템별로 수행되는 작업 유형입니다. Type: enum Possible values: Create, Delete, Update |
| params required | 라인 아이템 객체에 필요한 모든 매개변수를 포함하는 JSON 객체입니다. 필수 및 선택 매개변수 목록은 여기를 참고하세요. |
POST 'Content-Type: application/json' https://ads-api.x.com/12/batch/accounts/18ce54d4x5t/line_items
PUT accounts/:account_id/line_items/:line_item_id
현재 계정에 연결된 지정한 라인 아이템을 업데이트합니다. Resource URLhttps://ads-api.x.com/12/accounts/:account_id/line_items/:line_item_id
Parameters
| 이름 | 설명 |
|---|---|
| account_id required | 사용할 계정의 식별자입니다. 리소스 경로에 포함되며, GET accounts를 제외한 모든 광고주 API 요청에 필수 매개변수입니다. 지정된 계정은 인증된 사용자와 연결되어 있어야 합니다. 유형: string 예시: 18ce54d4x5t |
| line_item_id required | 요청에서 작업 중인 라인 아이템에 대한 참조입니다. 유형: string 예시: 8v7jo |
| advertiser_domain optional | 프로토콜 지정 없이 이 광고주의 웹사이트 도메인입니다. 참고: 라인 아이템의 게재위치가 PUBLISHER_NETWORK로 설정된 경우 필수입니다.유형: string 예시: x.com |
| advertiser_user_id optional | PREROLL_VIEWS 광고를 홍보하는 핸들의 X 사용자 식별자입니다. 특정 클라이언트 애플리케이션만 이 매개변수를 사용할 수 있습니다.유형: string 예시: 312226591 |
| android_app_store_identifier optional | 홍보할 애플리케이션의 Google App Store 식별자입니다. 참고: APP_INSTALLS 및 APP_ENGAGEMENTS 목표는 android_app_store_identifier 또는 ios_app_store_identifier 중 하나 이상의 앱 스토어 식별자 설정이 필요합니다.유형: string 예시: com.twitter.android |
| audience_expansion optional | 이미 타겟팅된 사용자와 유사한 사용자를 타겟팅하여 캠페인 도달 범위를 확장하는 데 사용됩니다. 유형: enum 가능한 값: BROAD, DEFINED, EXPANDED |
| bid_amount_local_micro optional | 이 라인 아이템과 연결될 입찰 금액입니다. 지정된 펀딩 인스트루먼트와 연결된 통화가 사용됩니다. USD의 경우 $5.50은 5500000으로 표시됩니다. 참고: bid_strategy가 MAX 또는 TARGET으로 설정된 경우 필수입니다.참고: 0보다 큰 값만 허용됩니다. 유형: long 예시: 140000 |
| bid_strategy optional | 입찰 메커니즘입니다.AUTO는 일일 예산 및 캠페인 게재 기간을 기반으로 입찰을 자동으로 최적화합니다.MAX는 허용 가능한 최대 입찰가를 설정하며 목표가 REACH 또는 FOLLOWERS로 설정된 경우 사용할 수 없습니다.TARGET은 일일 입찰 평균을 지정된 bid_amount_local_micro의 20% 이내로 유지하려고 시도하며 목표가 REACH 또는 WEBSITE_CLICKS로 설정된 경우 사용할 수 있습니다.참고: AUTO로 설정된 경우 bid_amount_local_micro는 무시됩니다.참고: 목표에 따라 기본값이 설정됩니다. 유형: enum 가능한 값: AUTO, MAX, TARGET |
| categories optional | 이 광고주와 관련된 IAB 카테고리입니다. GET iab_categories를 참조하십시오. 참고: 라인 아이템의 게재위치가 PUBLISHER_NETWORK로 설정된 경우 필수입니다.유형: string 예시: IAB3-1 |
| duration_in_days optional | frequency_cap이 달성되는 기간입니다.유형: int 가능한 값: 1, 7, 30 |
| entity_status optional | 라인 아이템 상태입니다. 유형: enum 가능한 값: ACTIVE, PAUSED |
| end_time optional | 라인 아이템이 게재를 중지할 시간으로 ISO 8601 형식으로 표현됩니다. 유형: string 예시: 2017-10-05T00:00:00Z |
| frequency_cap optional | 사용자에게 광고가 전달될 수 있는 최대 횟수입니다. 참고: REACH, ENGAGEMENTS, VIDEO_VIEWS 및 PREROLL_VIEWS 목표에만 지원됩니다.유형: int 예시: 5 |
| goal optional | 이 라인 아이템과 함께 사용할 최적화 설정입니다. APP_PURCHASES 옵션은 APP_INSTALL에 사용할 수 있습니다. APP_CLICKS 및 APP_INSTALLS 옵션은 APP_INSTALL 및 APP_ENGAGEMENTS에 사용할 수 있으며 지원되는 MACT 파트너 사용이 필요할 수 있습니다.참고: 목표에 따라 기본값이 설정됩니다. 유형: enum 가능한 값: APP_CLICKS, APP_INSTALLS, APP_PURCHASES, ENGAGEMENT, FOLLOWERS, LINK_CLICKS, MAX_REACH, PREROLL, PREROLL_STARTS, REACH_WITH_ENGAGEMENT, VIDEO_VIEW, VIEW_3S_100PCT, VIEW_6S, VIEW_15S, WEBSITE_CONVERSIONS |
| ios_app_store_identifier optional | 홍보할 애플리케이션의 Apple App Store 식별자 중 숫자 부분입니다. 참고: APP_INSTALLS 및 APP_ENGAGEMENTS 목표는 android_app_store_identifier 또는 ios_app_store_identifier 중 하나 이상의 앱 스토어 식별자 설정이 필요합니다.유형: string 예시: 333903271 |
| name optional | 라인 아이템의 이름입니다. 유형: string 예시: demo |
| pay_by optional | 이 라인 아이템에 청구할 단위입니다. 이 설정은 APP_INSTALLS 목표를 사용하는 라인 아이템에 대해서만 수정할 수 있습니다.참고: 기본 pay_by는 캠페인 목표 및 라인 아이템의 입찰 단위에 따라 자동으로 설정됩니다.APP_INSTALLS 목표는 APP_CLICK 및 IMPRESSION 값을 모두 지원합니다. IMPRESSION이 기본값입니다.LINK_CLICKS 목표는 LINK_CLICK 및 IMPRESSION 값을 모두 지원합니다. IMPRESSION이 기본값이지만 bid_strategy에 TARGET을 설정할 때는 지원되지 않습니다.SITE_VISITS 목표는 IMPRESSION 값을 지원합니다.유형: enum 가능한 값: APP_CLICK, IMPRESSION, LINK_CLICK |
| start_time optional | 라인 아이템이 게재를 시작할 시간으로 ISO 8601 형식으로 표현됩니다. 유형: string 예시: 2017-07-05T00:00:00Z |
| total_budget_amount_local_micro optional | 라인 아이템에 할당될 총 예산 금액입니다. 지정된 펀딩 인스트루먼트와 연결된 통화가 사용됩니다. USD의 경우 $37.50은 37500000으로 표시됩니다. 유형: long 예시: 37500000 |
| daily_budget_amount_local_micro optional | 캠페인에 할당될 일일 예산 금액입니다. 지정된 펀딩 인스트루먼트와 연결된 통화가 사용됩니다. USD의 경우 $5.50은 5500000으로 표시됩니다. 제공되지 않은 경우 캠페인은 총 예산 및 캠페인 게재 기간을 기반으로 균등하게 지출됩니다. 상위 캠페인의 budget_optimization이 LINE_ITEM으로 설정된 경우에만 사용할 수 있습니다.참고: 이 값은 total_budget_amount_local_micro보다 작거나 같아야 합니다.유형: long 예시: 5500000 |
PUT https://ads-api.x.com/12/accounts/18ce54d4x5t/line_items/9cqi0?bid_amount_local_micro=140000
응답 예시
DELETE accounts/:account_id/line_items/:line_item_id
현재 계정에 속한 지정된 라인 아이템을 삭제합니다. 참고: 라인 아이템 삭제는 되돌릴 수 없으며, 이후 해당 리소스를 다시 삭제하려는 시도는 HTTP 404를 반환합니다. 참고: 라인 아이템을 삭제해도 하위 promoted_tweets는 요청에with_deleted=true가 지정된 경우에 한해 GET accounts/:account_id/promoted_tweets 및 GET accounts/:account_id/promoted_tweets/:promoted_tweet_id 엔드포인트에서만 반환됩니다. 이러한 promoted_tweets는 실제로 삭제되지 않습니다(응답에서 "deleted": false). 연쇄 삭제는 수행되지 않습니다.
Resource URL
https://ads-api.x.com/12/accounts/:account_id/line_items/:line_item_id
Parameters
| Name | Description |
|---|---|
| account_id required | 활용 중인 계정의 식별자입니다. 리소스 경로에 포함되며 GET accounts를 제외한 모든 Advertiser API 요청에서 일반적으로 필수 매개변수입니다. 지정된 계정은 인증된 사용자와 연결되어 있어야 합니다. Type: string Example: 18ce54d4x5t |
| line_item_id required | 요청에서 대상이 되는 라인 아이템에 대한 참조입니다. Type: string Example: 9f2ix |
DELETE https://ads-api.x.com/12/accounts/18ce54d4x5t/line_items/9f2ix
Example Response
라인 아이템 선별 카테고리
GET accounts/:account_id/line_item_curated_categories
현재 계정에 연결된 라인 아이템 선별 카테고리의 세부 정보를 일부 또는 모두 조회합니다. Resource URLhttps://ads-api.x.com/12/accounts/:account_id/line_item_curated_categories
Parameters
| Name | Description |
|---|---|
| account_id required | 사용하는 계정의 식별자입니다. 리소스 경로에 포함되며, GET accounts를 제외한 모든 Advertiser API 요청에서 일반적으로 필수 매개변수입니다. 지정한 계정은 인증된 사용자와 연결되어 있어야 합니다. Type: string Example: 18ce54d4x5t |
| count optional | 각 요청에서 조회할 레코드 수를 지정합니다. Type: int Default: 200 Min, Max: 1, 1000 |
| cursor optional | 다음 페이지의 결과를 가져오기 위한 커서를 지정합니다. 자세한 내용은 Pagination을 참고하세요. Type: string Example: 8x7v00oow |
| sort_by optional | 지원되는 속성 기준으로 오름차순 또는 내림차순 정렬합니다. 자세한 내용은 Sorting을 참고하세요. Type: string Example: created_at-asc |
| with_deleted optional | 삭제된 결과를 포함합니다. Type: boolean Default: false Possible values: true, false |
| with_total_count optional | 응답에 total_count 속성을 포함합니다.Note: 이 매개변수와 cursor는 상호 배타적입니다.Note: total_count를 포함하는 요청은 더 낮은 요청 한도가 적용되며, 현재 15분당 200으로 설정되어 있습니다.Type: boolean Default: false Possible values: true, false |
GET https://ads-api.x.com/12/accounts/abc1/line_item_curated_categories
Example Response
GET accounts/:account_id/line_item_curated_categories/:line_item_curated_category_id
현재 계정과 연관된 특정 Line Item Curated Category의 세부 정보를 조회합니다. 리소스 URLhttps://ads-api.x.com/12/accounts/:account_id/line_item_curated_categories/:line_item_curated_category_id
매개변수
| Name | Description |
|---|---|
| account_id required | 사용 중인 계정의 식별자입니다. 리소스 경로에 포함되며, GET accounts를 제외한 대부분의 Advertiser API 요청에서 일반적으로 필요한 매개변수입니다. 지정한 계정은 인증된 사용자와 연동되어 있어야 합니다. Type: string Example: 18ce54d4x5t |
| line_item_curated_category_id required | 요청에서 대상이 되는 Line Item Curated Category를 가리키는 참조값입니다. Type: string Example: 43853bhii885 |
| with_deleted optional | 삭제된 결과를 포함할지 여부입니다. Type: boolean Default: false Possible values: true, false |
GET https://ads-api.x.com/12/accounts/abc1/line_item_curated_categories/yav
응답 예시
POST accounts/:account_id/line_item_curated_categories
지정한 라인 아이템에 curated category 객체를 연결합니다. 리소스 URLhttps://ads-api.x.com/12/accounts/:account_id/line_item_curated_categories
매개변수
| 이름 | 설명 |
|---|---|
account_id required | 사용 중인 계정의 식별자입니다. 리소스 경로에 포함되며, GET accounts를 제외한 모든 Advertiser API 요청에서 일반적으로 필요한 매개변수입니다. 지정한 계정은 인증된 사용자와 연결되어 있어야 합니다. 유형: string 예시: 18ce54d4x5t |
curated_category_id required | 요청에서 사용 중인 curated category 엔티티에 대한 참조입니다. 유형: string 예시: 10miy |
line_item_id required | 요청에서 사용 중인 라인 아이템에 대한 참조입니다. 유형: string 예시: 8v7jo |
POST https://ads-api.x.com/12/accounts/18ce54d4x5t/line_item_curated_categories?line_item_id=iqwka&curated_category_id=9ddrgesiap6o
예시 응답
PUT accounts/:account_id/line_item_curated_categories/:line_item_curated_category_id
지정한 라인 아이템 큐레이션 카테고리를 업데이트합니다. Resource URLhttps://ads-api.x.com/12/accounts/:account_id/line_item_curated_categories/:line_item_curated_category_id
Parameters
| Name | Description |
|---|---|
| account_id required | 사용 중인 계정의 식별자입니다. 리소스 경로에 포함되며, GET accounts를 제외한 모든 Advertiser API 요청에서 일반적으로 필수 매개변수입니다. 지정한 계정은 인증된 사용자와 연계되어 있어야 합니다. Type: string Example: 18ce54d4x5t |
| line_item_curated_category_id required | 요청에서 대상으로 하는 라인 아이템 큐레이션 카테고리에 대한 참조입니다. Type: string Example: 1bzq3 |
curated_category_id optional | 요청에서 대상으로 하는 큐레이션 카테고리 엔터티에 대한 참조입니다. Type: string Example: 10miy |
line_item_id optional | 요청에서 대상으로 하는 라인 아이템에 대한 참조입니다. Type: string Example: 8v7jo |
PUT https://ads-api.x.com/12/accounts/18ce54d4x5t/line_item_curated_categories/xq?curated_category_id=8tujl1p3yn0g
Example Response
DELETE accounts/:account_id/line_item_curated_categories/:line_item_curated_category_id
지정된 라인 아이템 큐레이션 카테고리를 삭제합니다. 리소스 URLhttps://ads-api.x.com/12/accounts/:account_id/line_item_curated_categories/:line_item_curated_category_id
매개변수
| Name | Description |
|---|---|
| account_id required | 사용 중인 계정의 식별자입니다. 리소스 경로에 포함되며, GET accounts를 제외한 모든 Advertiser API 요청에서 일반적으로 필수 매개변수입니다. 지정된 계정은 인증된 사용자와 연관되어 있어야 합니다. Type: string Example: 18ce54d4x5t |
| line_item_curated_category_id required | 요청에서 대상으로 하는 라인 아이템 큐레이션 카테고리에 대한 참조입니다. Type: string Example: 1bzq3 |
DELETE https://ads-api.x.com/12/accounts/18ce54d4x5t/line_item_curated_categories/xq
예시 응답
라인 아이템 배치
GET line_items/placements
유효한placement 및 product_type 조합을 가져옵니다.
Resource URL
https://ads-api.x.com/12/line_items/placements
Parameters
| Name | Description |
|---|---|
| product_type optional | 지정된 제품 유형에 대해 유효한 placement만 포함하도록 응답 범위를 제한합니다. Type: enum Possible values: MEDIA, PROMOTED_ACCOUNT, PROMOTED_TWEETS |
GET https://ads-api.x.com/12/line_items/placements?product_type=PROMOTED_ACCOUNT
Example Response
미디어 크리에이티브
GET accounts/:account_id/media_creatives
현재 계정과 연결된 일부 또는 모든 미디어 크리에이티브의 세부 정보를 조회합니다. 리소스 URLhttps://ads-api.x.com/12/accounts/:account_id/media_creatives
매개변수
| 이름 | 설명 |
|---|---|
| account_id 필수 | 활용 중인 계정의 식별자입니다. 리소스 경로에 포함되며, GET accounts를 제외한 모든 Advertiser API 요청에서 일반적으로 필수 매개변수입니다. 지정한 계정은 인증된 사용자와 연결되어 있어야 합니다. 유형: string 예시: 18ce54d4x5t |
| campaign_id 선택 | 지정된 캠페인과 연결된 미디어 크리에이티브만 반환하도록 응답 범위를 제한합니다. 유형: string 예시: 8gdx6 |
| count 선택 | 각 요청당 조회를 시도할 레코드 수를 지정합니다. 유형: int 기본값: 200 최소, 최대: 1, 1000 |
| cursor 선택 | 다음 페이지 결과를 가져오기 위한 커서를 지정합니다. 자세한 내용은 Pagination을 참조하세요. 유형: string 예시: 8x7v00oow |
| line_item_ids 선택 | 쉼표로 구분된 식별자 목록을 지정하여, 해당 라인 아이템과 연결된 미디어 크리에이티브만 반환하도록 응답 범위를 제한합니다. 최대 200개의 ID를 제공할 수 있습니다. 유형: string 예시: 8v7jo |
| media_creative_ids 선택 | 쉼표로 구분된 식별자 목록을 지정하여, 원하는 미디어 크리에이티브만 반환하도록 응답 범위를 제한합니다. 최대 200개의 ID를 제공할 수 있습니다. 유형: string 예시: 1bzq3 |
| sort_by 선택 | 지원되는 속성으로 오름차순 또는 내림차순 정렬합니다. 자세한 내용은 Sorting을 참조하세요. 유형: string 예시: created_at-asc |
| with_deleted 선택 | 삭제된 결과를 포함합니다. 유형: boolean 기본값: false 가능한 값: true, false |
| with_total_count 선택 | total_count 응답 속성을 포함합니다.참고: 이 매개변수와 cursor는 상호 배타적입니다.참고: total_count를 포함하는 요청은 더 낮은 요청 한도가 적용되며, 현재 15분당 200으로 설정되어 있습니다.유형: boolean 기본값: false 가능한 값: true, false |
GET https://ads-api.x.com/12/accounts/18ce54d4x5t/media_creatives?media_creative_ids=1bzq3
예시 응답
GET accounts/:account_id/media_creatives/:media_creative_id
현재 계정에 연결된 특정 미디어 크리에이티브의 세부 정보를 조회합니다. 리소스 URLhttps://ads-api.x.com/12/accounts/:account_id/media_creatives/:media_creative_id
매개변수
| Name | Description |
|---|---|
| account_id required | 사용 중인 계정의 식별자입니다. 리소스 경로에 포함되며, GET accounts를 제외한 모든 Advertiser API 요청에서 일반적으로 필수 매개변수입니다. 지정된 계정은 인증된 사용자와 연동되어 있어야 합니다. Type: string Example: 18ce54d4x5t |
| media_creative_id required | 이 요청에서 조회할 미디어 크리에이티브의 참조입니다. Type: string Example: 43853bhii885 |
| with_deleted optional | 삭제된 결과를 포함할지 여부입니다. Type: boolean Default: false Possible values: true, false |
GET https://ads-api.x.com/12/accounts/18ce54d4x5t/media_creatives/1bzq3
예시 응답
POST accounts/:account_id/media_creatives
지정된 라인 아이템에 account media 객체를 연결합니다. 이 엔드포인트를 사용하면 인스트림 광고(계정 미디어의creative_type이 PREROLL인 경우) 또는 이미지 광고(BANNER, INTERSTITIAL 등)를 Twitter Audience Platform에서 집행할 수 있습니다.
참고: Account Media 리소스에 미디어 에셋을 추가하려면 POST accounts/:account_id/media_library 엔드포인트를 사용하세요.
Resource URL
https://ads-api.x.com/12/accounts/:account_id/media_creatives
Parameters
| Name | Description |
|---|---|
account_id required | 사용 중인 계정의 식별자입니다. 리소스 경로에 포함되며, GET accounts를 제외한 모든 Advertiser API 요청에서 일반적으로 필수 매개변수입니다. 지정된 계정은 인증된 사용자와 연결되어 있어야 합니다. Type: string Example: 18ce54d4x5t |
account_media_id required | 이 요청에서 사용 중인 account media 엔터티에 대한 참조입니다. Type: string Example: 10miy |
line_item_id required | 이 요청에서 사용 중인 라인 아이템에 대한 참조입니다. Type: string Example: 8v7jo |
landing_url sometimes required | 사용자를 이동시킬 웹사이트의 URL입니다. TAP 이미지(또는 “display creatives”)에서만 사용해야 합니다. preroll 에셋과 함께 사용하면 이 값은 무시됩니다. preroll 에셋에 URL을 연결하려면 POST accounts/:account_id/preroll_call_to_actions 엔드포인트를 사용하세요. 참고: 라인 아이템의 objective가 WEBSITE_CLICKS로 설정된 경우 필수입니다.Type: string Example: https://blog.x.com/ |
POST https://ads-api.x.com/12/accounts/18ce54d4x5t/media_creatives?line_item_id=8v7jo&account_media_id=10miy
Example Response
DELETE accounts/:account_id/media_creatives/:media_creative_id
현재 계정에 속한 지정된 미디어 크리에이티브를 삭제합니다. 리소스 URLhttps://ads-api.x.com/12/accounts/:account_id/media_creatives/:media_creative_id
매개변수
| 이름 | 설명 |
|---|---|
| account_id 필수 | 사용하는 계정의 식별자입니다. 리소스 경로에 포함되며, GET accounts를 제외한 모든 Advertiser API 요청에서 일반적으로 필수 매개변수입니다. 지정된 계정은 인증된 사용자와 연결되어 있어야 합니다. 유형: string 예시: 18ce54d4x5t |
| media_creative_id 필수 | 요청에서 대상으로 하는 미디어 크리에이티브에 대한 참조입니다. 유형: string 예시: 1bzq3 |
DELETE https://ads-api.x.com/12/accounts/18ce54d4x5t/media_creatives/1bzq3
응답 예시
프로모션 계정
GET accounts/:account_id/promoted_accounts
현재 계정에서 하나 이상의 라인 아이템과 연결된 일부 또는 모든 프로모션 계정의 세부 정보를 조회합니다. 응답에서user_id로 식별된 사용자 계정의 사용자 데이터를 얻으려면 GET users/lookup을 사용하세요.
지정한 라인 아이템 중 어느 것도 프로모션 계정을 포함하도록 구성되지 않은 경우 HTTP 400이 반환됩니다.
리소스 URL
https://ads-api.x.com/12/accounts/:account_id/promoted_accounts
매개변수
| 이름 | 설명 |
|---|---|
| account_id required | 활용 중인 계정의 식별자입니다. 리소스 경로에 포함되며, GET accounts를 제외한 모든 Advertiser API 요청에서 일반적으로 필수 매개변수입니다. 지정된 계정은 인증된 사용자와 연결되어 있어야 합니다. Type: string Example: 18ce54d4x5t |
| count optional | 각 요청에서 조회할 레코드 수를 지정합니다. Type: int Default: 200 Min, Max: 1, 1000 |
| cursor optional | 다음 결과 페이지를 가져오기 위한 커서를 지정합니다. 자세한 내용은 Pagination을 참조하세요. Type: string Example: 8x7v00oow |
| line_item_ids optional | 쉼표로 구분된 식별자 목록을 지정하여 응답을 해당 라인 아이템에 연결된 프로모션 계정으로만 제한합니다. 최대 200개의 ID를 제공할 수 있습니다. Type: string Example: 9bpb2 |
| promoted_account_ids optional | 쉼표로 구분된 식별자 목록을 지정하여 응답을 원하는 프로모션 계정으로만 제한합니다. 최대 200개의 ID를 제공할 수 있습니다. Type: string Example: 19pl2 |
| sort_by optional | 지원되는 속성을 기준으로 오름차순 또는 내림차순으로 정렬합니다. 자세한 내용은 Sorting을 참조하세요. Type: string Example: created_at-asc |
| with_deleted optional | 삭제된 결과를 포함합니다. Type: boolean Default: false Possible values: true, false |
| with_total_count optional | total_count 응답 속성을 포함합니다.참고: 이 매개변수와 cursor는 상호 배타적입니다.참고: total_count를 포함하는 요청에는 더 낮은 요청 한도가 적용되며, 현재 15분당 200으로 설정되어 있습니다.Type: boolean Default: false Possible values: true, false |
GET https://ads-api.x.com/12/accounts/18ce54d4x5t/promoted_accounts?promoted_account_ids=19pl2
예시 응답
GET accounts/:account_id/promoted_accounts/:promoted_account_id
현재 계정의 라인 아이템에 연결된 계정에 대한 특정 레퍼런스를 조회합니다. Resource URLhttps://ads-api.x.com/12/accounts/:account_id/promoted_accounts/:promoted_account_id
Parameters
| Name | Description |
|---|---|
| account_id required | 활용 중인 계정의 식별자입니다. 리소스 경로에 포함되며 GET accounts를 제외한 대부분의 Advertiser API 요청에서 필수 매개변수입니다. 지정한 계정은 인증된 사용자와 연계되어 있어야 합니다. Type: string Example: 18ce54d4x5t |
| promoted_account_id required | 해당 요청에서 작업 대상이 되는 프로모션 계정에 대한 참조입니다. Type: string Example: 19pl2 |
| with_deleted optional | 삭제된 결과를 포함할지 여부입니다. Type: boolean Default: false Possible values: true, false |
GET https://ads-api.x.com/12/accounts/18ce54d4x5t/promoted_accounts/19pl2
Example Response
POST accounts/:account_id/promoted_accounts
지정한 라인 아이템에 계정(user_id)을 연결합니다.
지정한 라인 아이템이 Promoted Accounts와의 연결로 구성되어 있지 않으면 HTTP 400 INCOMPATIBLE_LINE_ITEM 오류가 반환됩니다. 지정한 사용자가 프로모션 대상이 아니면 HTTP 400이 반환되며 어떤 사용자도 프로모션되지 않습니다. 제공한 사용자가 이미 프로모션된 상태라면 요청은 무시됩니다.
Promoted Accounts에 대한 자세한 내용은 campaign management 페이지를 참고하세요.
참고: promoted accounts 엔터티는 업데이트(PUT)할 수 없습니다.
Resource URL
https://ads-api.x.com/12/accounts/:account_id/promoted_accounts
Parameters
| Name | Description |
|---|---|
| account_id required | 활용 계정의 식별자입니다. 리소스 경로에 포함되며, GET accounts를 제외한 모든 Advertiser API 요청에서 일반적으로 필수 매개변수입니다. 지정한 계정은 인증된 사용자와 연결되어 있어야 합니다. Type: string Example: 18ce54d4x5t |
| line_item_id required | 요청에서 작업하는 라인 아이템에 대한 참조입니다. Type: string Example: 9bpb2 |
| user_id required | 요청에서 작업하는 사용자에 대한 참조입니다. 화면 이름에 대한 사용자 ID를 조회하려면 GET users/lookup을 사용하세요. Type: long Example: 756201191646691328 |
POST https://ads-api.x.com/12/accounts/18ce54d4x5t/promoted_accounts?line_item_id=9bpb2&user_id=756201191646691328
Example Response
DELETE accounts/:account_id/promoted_accounts/:promoted_account_id
지정된 라인 아이템에서 계정 연결을 해제합니다. 리소스 URLhttps://ads-api.x.com/12/accounts/:account_id/promoted_accounts/:promoted_account_id
매개변수
| Name | Description |
|---|---|
| account_id required | 활용 중인 계정의 식별자입니다. 리소스 경로에 포함되며 GET accounts를 제외한 모든 Advertiser API 요청에서 일반적으로 필수 매개변수입니다. 지정된 계정은 인증된 사용자와 연결되어 있어야 합니다. Type: string Example: 18ce54d4x5t |
| promoted_account_id required | 라인 아이템과 연결된 Promoted Account 인스턴스의 식별자입니다. Type: string Example: 19pl2 |
DELETE https://ads-api.x.com/12/accounts/18ce54d4x5t/promoted_accounts/19pl2
응답 예시
프로모션 게시물
GET accounts/:account_id/promoted_tweets
현재 계정의 라인 아이템과 연결된 Tweet 참조를 조회합니다. GET accounts/:account_id/tweets 엔드포인트를 사용해 Tweet 객체를 가져오세요. 각 promoted_tweets 객체에는tweet_id 값을 사용하세요.
참고: 상위 라인 아이템이 삭제된 경우, 요청에 with_deleted=true를 지정한 때에만 promoted_tweets가 반환됩니다. 단, 이러한 promoted_tweets는 실제로 삭제된 것이 아닙니다(응답에서 "deleted": false).
리소스 URL
https://ads-api.x.com/12/accounts/:account_id/promoted_tweets
매개변수
| Name | Description |
|---|---|
| account_id required | 사용 중인 계정의 식별자입니다. 리소스 경로에 포함되며 GET accounts를 제외한 대부분의 Advertiser API 요청에서 일반적으로 필수 매개변수입니다. 지정한 계정은 인증된 사용자와 연계되어 있어야 합니다. Type: string Example: 18ce54d4x5t |
| count optional | 각 요청에서 조회를 시도할 레코드 수를 지정합니다. Type: int Default: 200 Min, Max: 1, 1000 |
| cursor optional | 다음 페이지 결과를 가져오기 위한 커서를 지정합니다. 자세한 내용은 Pagination을 참조하세요. Type: string Example: 8x7v00oow |
| line_item_ids optional | 쉼표로 구분된 식별자 목록을 지정하여 특정 라인 아이템과 연결된 Tweet만으로 응답 범위를 제한합니다. 최대 200개의 ID를 제공할 수 있습니다. Type: string Example: 96uzp |
| promoted_tweet_ids optional | 쉼표로 구분된 식별자 목록을 지정하여 원하는 promoted Tweet만으로 응답 범위를 제한합니다. 최대 200개의 ID를 제공할 수 있습니다. Type: string Example: 1efwlo |
| sort_by optional | 지원되는 속성으로 오름차순 또는 내림차순 정렬합니다. 자세한 내용은 Sorting을 참조하세요. Type: string Example: created_at-asc |
| with_deleted optional | 삭제된 결과를 포함합니다. Type: boolean Default: false Possible values: true, false |
| with_total_count optional | total_count 응답 속성을 포함합니다.참고: 이 매개변수와 cursor는 상호 배타적입니다.참고: total_count를 포함하는 요청은 더 낮은 요청 한도가 적용되며, 현재 15분당 200건으로 설정되어 있습니다.Type: boolean Default: false Possible values: true, false |
GET https://ads-api.x.com/12/accounts/18ce54d4x5t/promoted_tweets?promoted_tweet_ids=1efwlo
응답 예시
GET accounts/:account_id/promoted_tweets/:promoted_tweet_id
현재 계정의 라인 아이템에 연결된 특정 Tweet 참조를 조회합니다. 참고: 상위 라인 아이템이 삭제된 경우, 요청에with_deleted=true가 지정된 때에만 promoted_tweets가 반환됩니다. 이러한 promoted_tweets는 실제로 삭제된 것이 아닙니다(응답의 "deleted": false 참조).
리소스 URL
https://ads-api.x.com/12/accounts/:account_id/promoted_tweets/:promoted_tweet_id
매개변수
| 이름 | 설명 |
|---|---|
| account_id 필수 | 사용 중인 계정의 식별자입니다. 리소스 경로에 포함되며, GET accounts를 제외한 대부분의 Advertiser API 요청에서 일반적으로 필수 매개변수입니다. 지정한 계정은 인증된 사용자와 연결되어 있어야 합니다. 유형: string 예시: 18ce54d4x5t |
| promoted_tweet_id 필수 | 요청에서 대상이 되는 프로모션된 Tweet의 참조입니다. 유형: string 예시: 1efwlo |
| with_deleted 선택 | 삭제된 결과를 포함할지 여부입니다. 유형: boolean 기본값: false 가능한 값: true, false |
GET https://ads-api.x.com/12/accounts/18ce54d4x5t/promoted_tweets/1efwlo
응답 예시
POST accounts/:account_id/promoted_tweets
지정한 라인 아이템에 하나 이상의 게시물을 연결합니다. 캠페인 목표에 따라 모든 게시물이 프로모션에 적합한 것은 아닙니다. 자세한 내용은 Objective-based Campaigns를 참고하세요.PROMOTED_ACCOUNT 제품 유형을 사용할 때 line_item에 게시물을 연결하면 표준 PROMOTED_ACCOUNT 게재 위치에 더해 모바일 타임라인 게재가 추가됩니다.
참고: 프로모션된 게시물 엔터티는 업데이트(PUT)할 수 없습니다.
Resource URL
https://ads-api.x.com/12/accounts/:account_id/promoted_tweets
Parameters
| Name | Description |
|---|---|
| account_id required | 연결된 계정의 식별자입니다. 리소스 경로에 포함되며 GET accounts를 제외한 모든 Advertiser API 요청에서 일반적으로 필요한 매개변수입니다. 지정된 계정은 인증된 사용자와 연계되어 있어야 합니다. Type: string Example: 18ce54d4x5t |
| line_item_id required | 이 요청에서 작업 중인 라인 아이템에 대한 참조입니다. Type: string Example: 8v7jo |
| tweet_ids required | 특정 게시물에 해당하는 식별자의 쉼표로 구분된 목록입니다. 최대 50개의 ID를 제공할 수 있습니다. Type: long Example: 822333526255120384 |
POST https://ads-api.x.com/12/accounts/18ce54d4x5t/promoted_tweets?line_item_id=8v7jo&tweet_ids=822333526255120384
Example Response
DELETE accounts/:account_id/promoted_tweets/:promoted_tweet_id
지정된 라인 아이템에서 트윗 연결을 해제합니다. 참고: 삭제된 promoted_tweets 엔터티는 ads.x.com UI에서 “Paused”로 표시됩니다. 마찬가지로 UI에서 “일시 정지”를 수행하면 해당 트윗이 해당 라인 아이템과의 연결이 해제됩니다. Resource URLhttps://ads-api.x.com/12/accounts/:account_id/promoted_tweets/:promoted_tweet_id
Parameters
| Name | Description |
|---|---|
| account_id required | 사용 중인 계정의 식별자입니다. 리소스 경로에 포함되며, GET accounts를 제외한 대부분의 Advertiser API 요청에서 일반적으로 필수 매개변수입니다. 지정한 계정은 인증된 사용자와 연결되어 있어야 합니다. Type: string Example: 18ce54d4x5t |
| promoted_tweet_id required | 라인 아이템과 연결된 Promoted Tweet 인스턴스를 가리키는 식별자입니다. 해당 트윗의 tweet_id가 아니라 GET accounts/:account_id/promoted_tweets의 응답 항목에 포함된 id 필드 값입니다. 리소스 경로에 포함됩니다.Type: string Example: 1gp8a5 |
DELETE https://ads-api.x.com/12/accounts/18ce54d4x5t/promoted_tweets/1gp8a5
Example Response
프로모션 대상 사용자
GET accounts/:account_id/promotable_users
현재 계정과 연결된 프로모션 가능 사용자 일부 또는 전체의 세부 정보를 조회합니다. 프로모션 가능 사용자 유형은FULL 또는 RETWEETS_ONLY입니다. 이는 계정이 프로모션할 수 있는 콘텐츠의 종류를 결정합니다. 광고주는 다른 사용자의 콘텐츠를 프로모션하려면 권한을 받아야 하며, 해당 사용자를 RETWEETS_ONLY 프로모션 가능 사용자로 계정에 추가하려면 Twitter에 문의해야 합니다.
권한이 올바르게 설정되어 있으면 프로모션하려는 Tweet의 Tweet ID를 직접 참조하는 프로모션 제품 엔드포인트에 요청할 수 있습니다. POST accounts/:account_id/promoted-tweets 엔드포인트로 게시된 Tweet을 프로모션할 수 있고, POST accounts/:account_id/scheduled-promoted-tweets 엔드포인트로 다른 Twitter Ads 계정의 예약된 Tweet을 프로모션할 수 있습니다.
대상 Tweet을 리트윗할 필요는 없습니다. 이 방식으로 Tweet을 프로모션하면 반환되는 tweet_id는 제공된 Tweet ID와 다릅니다. 내부적으로 해당 Tweet은 nullcasted Tweet으로 리트윗된 뒤 프로모션됩니다. 반환되는 tweet_id는 이 새로운 Tweet을 가리킵니다.
Resource URL
https://ads-api.x.com/12/accounts/:account_id/promotable_users
Parameters
| Name | Description |
|---|---|
| account_id required | 사용 중인 계정의 식별자입니다. 리소스 경로에 포함되며, GET accounts를 제외한 모든 Advertiser API 요청에서 일반적으로 필수 매개변수입니다. 지정된 계정은 인증된 사용자와 연결되어 있어야 합니다. Type: string Example: 18ce54d4x5t |
| count optional | 각 요청당 조회할 레코드 수를 지정합니다. Type: int Default: 200 Min, Max: 1, 1000 |
| cursor optional | 다음 페이지 결과를 가져오기 위한 커서를 지정합니다. 자세한 내용은 Pagination을 참조하세요. Type: string Example: 8x7v00oow |
| promotable_user_ids optional | 쉼표로 구분된 식별자 목록을 지정해 응답을 원하는 프로모션 가능 사용자로만 제한합니다. 최대 200개의 ID를 제공할 수 있습니다. Type: string Example: l310s |
| sort_by optional | 지원되는 속성 기준으로 오름차순 또는 내림차순 정렬합니다. 자세한 내용은 Sorting을 참조하세요. Type: string Example: created_at-asc |
| with_deleted optional | 삭제된 결과를 포함합니다. Type: boolean Default: false Possible values: true, false |
| with_total_count optional | total_count 응답 속성을 포함합니다.Note: 이 매개변수와 cursor는 상호 배타적입니다.Note: total_count를 포함한 요청은 더 낮은 요청 한도가 적용되며, 현재 15분당 200으로 설정되어 있습니다.Type: boolean Default: false Possible values: true, false |
GET https://ads-api.x.com/12/accounts/18ce54d4x5t/promotable_users?promotable_user_ids=l310s
Example Response
GET accounts/:account_id/promotable_users/:promotable_user_id
현재 계정과 연동된 특정 프로모션 대상 사용자(promotable user)를 조회합니다. 프로모션 대상 사용자 유형은FULL 또는 RETWEETS_ONLY입니다. 이는 해당 계정이 프로모션할 수 있는 콘텐츠 유형을 결정합니다.
광고주는 다른 사용자의 콘텐츠를 프로모션하려면 권한을 획득해야 합니다. 권한이 올바르게 설정되어 있다면, 프로모션하려는 Tweet의 Tweet ID를 직접 참조하는 프로모션 제품 엔드포인트로 요청을 보낼 수 있습니다.
대상 Tweet을 리트윗할 필요는 없습니다. 이 방식으로 Tweet을 프로모션하면 반환되는 tweet_id는 제공한 Tweet ID와 다릅니다. 내부적으로 해당 Tweet은 nullcast된 Tweet으로 리트윗된 뒤 프로모션됩니다. 반환되는 tweet_id는 이 새로운 Tweet에 해당합니다.
Resource URL
https://ads-api.x.com/12/accounts/:account_id/promotable_users/:promotable_user_id
Parameters
| Name | Description |
|---|---|
| account_id required | 활용 계정의 식별자입니다. 리소스 경로에 포함되며, GET accounts를 제외한 모든 Advertiser API 요청에서 일반적으로 필수 매개변수입니다. 지정한 계정은 인증된 사용자와 연동되어 있어야 합니다. Type: string Example: 18ce54d4x5t |
| promotable_user_id optional | 해당 요청에서 작업 대상이 되는 프로모션 대상 사용자에 대한 참조입니다. Type: string Example: l310s |
| with_deleted optional | 삭제된 결과를 요청에 포함합니다. Type: boolean Default: false Possible values: true, false |
GET https://ads-api.x.com/12/accounts/18ce54d4x5t/promotable_users/l310s
Example Response
퍼블리셔
https://ads-api.x.com/12/publishers
매개변수
요청 매개변수 없음
예제 요청
GET https://ads-api.x.com/12/publishers
예제 응답
권장 사항
GET accounts/:account_id/recommendations
상태: 클로즈드 베타 이 광고 계정과 연관된 캠페인 추천을 조회합니다. 현재 자금 조달 수단당 추천은 1개로 제한됩니다. 리소스 URLhttps://ads-api.x.com/5/accounts/:account_id/recommendations
매개변수
| 이름 | 설명 |
|---|---|
| account_id required | 대상 계정의 식별자입니다. 리소스 경로에 포함되며, GET accounts를 제외한 모든 Advertiser API 요청에서 일반적으로 필수 매개변수입니다. 지정된 계정은 인증된 사용자와 연결되어 있어야 합니다. 유형: string 예시: 18ce54d4x5t |
GET https://ads-api.x.com/5/accounts/18ce54d4x5t/recommendations
응답 예시
GET accounts/:account_id/recommendations/:recommendation_id
Status: 클로즈드 베타 이 광고 계정과 연결된 특정 캠페인 추천을 조회합니다. 캠페인 추천에는 객체 트리로 표현된 캠페인 구조에 대해 제안된 변경 사항 전체가 포함됩니다. 응답 트리는 Batch API 엔드포인트와 함께 사용하도록 설계되었지만, 필요에 따라 단일 업데이트 엔드포인트에 매핑할 수도 있습니다(POST는 생성, PUT은 업데이트, DELETE는 삭제). Resource URLhttps://ads-api.x.com/5/accounts/:account_id/recommendations/:recommendation_id
Parameters
| Name | Description |
|---|---|
| account_id 필수 | 사용 중인 계정의 식별자입니다. 리소스 경로에 포함되며, GET accounts를 제외한 모든 Advertiser API 요청에 일반적으로 요구되는 매개변수입니다. 지정된 계정은 인증된 사용자와 연계되어 있어야 합니다. Type: string Example: 18ce54d4x5t |
| recommendation_id 필수 | 이 요청에서 대상으로 하는 추천 ID에 대한 참조입니다. Type: string Example: 62ce8zza1q0w |
GET https://ads-api.x.com/5/accounts/18ce54d4x5t/recommendations/62ce8zza1q0w
Example Response
예약된 프로모션용 게시물
GET accounts/:account_id/scheduled_promoted_tweets
현재 계정과 연결된 예약된 프로모션용 Tweet의 일부 또는 전체에 대한 세부 정보를 조회합니다. Resource URLhttps://ads-api.x.com/12/accounts/:account_id/scheduled_promoted_tweets
Parameters
| Name | Description |
|---|---|
| account_id required | 사용 중인 계정의 식별자입니다. 리소스 경로에 포함되며 GET accounts를 제외한 모든 Advertiser API 요청에서 일반적으로 필수 매개변수입니다. 지정된 계정은 인증된 사용자와 연결되어 있어야 합니다. Type: string Example: 18ce54d4x5t |
| count optional | 각 요청마다 조회를 시도할 레코드 수를 지정합니다. Type: int Default: 200 Min, Max: 1, 1000 |
| cursor optional | 다음 결과 페이지를 가져오기 위한 커서를 지정합니다. 자세한 내용은 Pagination을 참조하세요. Type: string Example: 8x7v00oow |
| line_item_ids optional | 식별자를 쉼표로 구분하여 제공해 특정 라인 아이템과 연결된 예약된 Tweet만 응답에 포함하도록 범위를 제한합니다. 최대 200개의 ID를 제공할 수 있습니다. Type: string Example: 8xdpe |
| scheduled_promoted_tweet_ids optional | 식별자를 쉼표로 구분하여 제공해 원하는 예약된 프로모션용 Tweet만 응답에 포함하도록 범위를 제한합니다. 최대 200개의 ID를 제공할 수 있습니다. Type: string Example: 1xboq |
| sort_by optional | 지원되는 속성 기준으로 오름차순 또는 내림차순 정렬합니다. 자세한 내용은 Sorting을 참조하세요. Type: string Example: created_at-asc |
| with_deleted optional | 삭제된 결과를 포함합니다. Type: boolean Default: false Possible values: true, false |
| with_total_count optional | 응답에 total_count 속성을 포함합니다.Note: 이 매개변수와 cursor는 상호 배타적입니다.Note: total_count를 포함한 요청은 더 낮은 요청 한도가 적용되며, 현재 15분당 200으로 설정되어 있습니다.Type: boolean Default: false Possible values: true, false |
GET https://ads-api.x.com/12/accounts/18ce54d4x5t/scheduled_promoted_tweets?scheduled_promoted_tweet_ids=1xboq
Example Response
GET accounts/:account_id/scheduled_promoted_tweets/:scheduled_promoted_tweet_id
현재 계정에 연결된 특정 예약 프로모션 Tweet을 조회합니다. Resource URLhttps://ads-api.x.com/12/accounts/:account_id/scheduled_promoted_tweets/:scheduled_promoted_tweet_id
Parameters
| Name | Description |
|---|---|
| account_id required | 사용 중인 계정의 식별자입니다. 리소스 경로에 포함되며, GET accounts를 제외한 대부분의 Advertiser API 요청에 필요한 매개변수입니다. 지정한 계정은 인증된 사용자와 연결되어 있어야 합니다. Type: string Example: 18ce54d4x5t |
| scheduled_promoted_tweet_id required | 이 요청에서 대상으로 하는 예약 프로모션 Tweet의 참조값입니다. Type: string Example: 1xboq |
| with_deleted optional | 삭제된 결과를 포함할지 여부입니다. Type: boolean Default: false Possible values: true, false |
GET https://ads-api.x.com/12/accounts/18ce54d4x5t/scheduled_promoted_tweets/1xboq
Example Response
POST accounts/:account_id/scheduled_promoted_tweets
지정된 라인 아이템에 예약된 게시물을 연결합니다. 참고: 예약된 프로모션 게시물 엔터티는 업데이트(PUT)할 수 없습니다. Resource URLhttps://ads-api.x.com/12/accounts/:account_id/scheduled_promoted_tweets
Parameters
| Name | Description |
|---|---|
| account_id required | 사용하는 계정의 식별자입니다. 리소스 경로에 포함되며, GET accounts를 제외한 모든 Advertiser API 요청에서 일반적으로 필요한 매개변수입니다. 지정된 계정은 인증된 사용자와 연결되어 있어야 합니다. Type: string Example: 18ce54d4x5t |
| line_item_id required | 요청에서 작업 중인 라인 아이템에 대한 참조입니다. Type: string Example: 8xdpe |
| scheduled_tweet_id required | 요청에서 작업 중인 예약된 게시물에 대한 참조입니다. Type: long Example: 870358555227860992 |
POST https://ads-api.x.com/12/accounts/18ce54d4x5t/scheduled_promoted_tweets?line_item_id=8xdpe&scheduled_tweet_id=870358555227860992
Example Response
DELETE accounts/:account_id/scheduled_promoted_tweets/:scheduled_promoted_tweet_id
지정된 라인 아이템에서 예약된 트윗의 연결을 해제합니다. 참고:scheduled_promoted_tweets는 예약된 트윗의 scheduled_at 시간 이전에만 삭제할 수 있습니다.
리소스 URL
https://ads-api.x.com/12/accounts/:account_id/scheduled_tweets/:scheduled_tweet_id
매개변수
| Name | Description |
|---|---|
| account_id required | 사용 중인 계정의 식별자입니다. 리소스 경로에 포함되며 GET accounts를 제외한 모든 Advertiser API 요청에서 일반적으로 필수 매개변수입니다. 지정된 계정은 인증된 사용자와 연결되어 있어야 합니다. Type: string Example: 18ce54d4x5t |
| scheduled_promoted_tweet_id required | 이 요청에서 대상으로 하는 예약 프로모션 트윗을 가리키는 참조입니다. GET accounts/:account_id/scheduled_promoted_tweets 응답 객체의 id 속성입니다.Type: string Example: 1xtfl |
DELETE https://ads-api.x.com/12/accounts/18ce54d4x5t/scheduled_promoted_tweets/1xtfl
예시 응답
타게팅 기준
GET accounts/:account_id/targeting_criteria
현재 계정의 라인 아이템에 연결된 일부 또는 모든 타기팅 기준의 세부 정보를 조회합니다. Resource URLhttps://ads-api.x.com/12/accounts/:account_id/targeting_criteria
Parameters
| Name | Description |
|---|---|
| account_id required | 사용 중인 계정의 식별자입니다. 리소스 경로에 포함되며 GET accounts를 제외한 모든 Advertiser API 요청에서 일반적으로 필수 매개변수입니다. 지정한 계정은 인증된 사용자와 연결되어 있어야 합니다. Type: string Example: 18ce54d4x5t |
| line_item_ids required | 쉼표로 구분된 식별자 목록을 지정하여, 지정된 라인 아이템의 타기팅 기준만 응답에 포함되도록 범위를 제한합니다. 최대 200개의 ID를 제공할 수 있습니다. Type: string Example: 8u94t |
| count optional | 각 요청당 조회할 레코드 수를 지정합니다. Type: int Default: 200 Min, Max: 1, 1000 |
| cursor optional | 다음 결과 페이지를 가져오기 위한 커서를 지정합니다. 자세한 내용은 Pagination을 참조하세요. Type: string Example: 8x7v00oow |
| lang optional | ISO-639-1 언어 코드입니다. 이 값을 전달하면, 현지화된 이름이 제공되는 객체에 한해 응답에 localized_name 속성이 추가로 반환됩니다.Type: string Example: fr |
| sort_by optional | 지원되는 속성을 기준으로 오름차순 또는 내림차순 정렬합니다. 자세한 내용은 Sorting을 참조하세요. Type: string Example: created_at-asc |
| targeting_criterion_ids optional | 쉼표로 구분된 식별자 목록을 지정하여, 원하는 타기팅 기준만 응답에 포함되도록 범위를 제한합니다. 최대 200개의 ID를 제공할 수 있습니다. Type: string Example: dpl3a6 |
| with_deleted optional | 삭제된 결과를 포함합니다. Type: boolean Default: false Possible values: true, false |
| with_total_count optional | 응답에 total_count 속성을 포함합니다.참고: 이 매개변수와 cursor는 상호 배타적입니다.참고: total_count를 포함하는 요청은 더 낮은 요청 한도가 적용되며, 현재 15분당 200회로 설정되어 있습니다.Type: boolean Default: false Possible values: true, false |
GET https://ads-api.x.com/12/accounts/18ce54d4x5t/targeting_criteria?line_item_ids=8u94t
Example Response
GET accounts/:account_id/targeting_criteria/:targeting_criterion_id
현재 계정에 연결된 특정 타기팅 기준을 조회합니다. 리소스 URLhttps://ads-api.x.com/12/accounts/:account_id/targeting_criteria/:targeting_criterion_id
매개변수
| Name | Description |
|---|---|
| account_id required | 사용하는 계정의 식별자입니다. 리소스 경로에 포함되며, GET accounts를 제외한 모든 Advertiser API 요청에서 일반적으로 필수입니다. 지정한 계정은 인증된 사용자와 연동되어 있어야 합니다. Type: string Example: 18ce54d4x5t |
| targeting_criterion_id required | 요청에서 조회하려는 타기팅 기준을 가리키는 참조입니다. Type: string Example: eijd4y |
| lang optional | ISO-639-1 언어 코드입니다. 이 값을 전달하면, 현지화된 이름이 제공되는 객체의 응답에 localized_name 속성이 추가로 반환됩니다.Type: string Example: fr |
| with_deleted optional | 삭제된 결과를 포함합니다. Type: boolean Default: false Possible values: true, false |
GET https://ads-api.x.com/12/accounts/18ce54d4x5t/targeting_criteria/eijd4y
예시 응답
POST accounts/:account_id/targeting_criteria
특정 타기팅 유형에 해당하는targeting_value를 찾으려면 Targeting Options 페이지를 확인하세요. 최신 타기팅 값으로 작업할 수 있도록 모든 데이터를 매주 새로 고치길 권장합니다. 값과 사용 가능한 타기팅 기준은 수시로 변경됩니다. 대부분은 자주 바뀌지 않지만 일부는 변경됩니다. 이러한 값이 변하지 않음을 보장할 수 없습니다.
targeting_value에 지정된 키워드와 함께 BROAD_KEYWORD, EXACT_KEYWORD, PHRASE_KEYWORD, UNORDERED_KEYWORD 타기팅 유형을 사용하세요. 키워드를 제외하려면 operator_type 요청 매개변수를 NE로 설정하세요. 각 유형에 대한 자세한 설명은 targeting keyword types을 참조하세요.
참고: 라인 아이템당 하나의 연령 버킷만 타기팅할 수 있습니다.
참고: Custom Audience를 타기팅하려면 해당 오디언스가 타기팅 가능해야 합니다. 즉, targetable이 반드시 true여야 합니다.
참고: TV_SHOW 타기팅 유형을 사용할 때는 TV_SHOW 타기팅을 설정하기 전에 라인 아이템에 최소 하나의 LOCATION 타기팅 기준이 있어야 하며, 모든 LOCATION은 타기팅하려는 TV_SHOW와 동일한 로케일 내에 있어야 합니다.
Resource URL
https://ads-api.x.com/12/accounts/:account_id/targeting_criteria
Parameters
| Name | Description |
|---|---|
| account_id required | 활용되는 계정의 식별자입니다. 리소스 경로에 포함되며, GET accounts를 제외한 모든 Advertiser API 요청에서 일반적으로 필요한 매개변수입니다. 지정된 계정은 인증된 사용자와 연관되어 있어야 합니다. Type: string Example: 18ce54d4x5t |
| line_item_id required | 요청에서 작업 중인 라인 아이템의 참조입니다. Type: string Example: 69ob |
| operator_type required | 타기팅 기준이 가져야 하는 관계를 지정합니다. 예를 들어 키워드를 제외하려면 operator_type=NE를 사용합니다.Type: enum Possible values: EQ, NE, GTE, LT |
| targeting_type required | 이 라인 아이템에 적용될 타기팅 유형입니다. 키워드 기반이 아닌 가능한 값: AGE, DEVICE, EVENT, CAMPAIGN_ENGAGEMENT, CAMPAIGN_ENGAGEMENT_LOOKALIKE, CONVERSATION, ENGAGEMENT_TYPE, FOLLOWERS_OF_USER, GENDER, INTEREST, LANGUAGE, LIVE_TV_EVENT, LOCATION, NETWORK_ACTIVATION_DURATION, NETWORK_OPERATOR, PLATFORM, PLATFORM_VERSION, SIMILAR_TO_FOLLOWERS_OF_USER, TV_SHOW, USER_ENGAGEMENT, USER_ENGAGEMENT_LOOKALIKE, WIFI_ONLY참고: 라인 아이템당 하나의 AGE 버킷만 타기팅할 수 있습니다.키워드 기반의 가능한 값: BROAD_KEYWORD, EXACT_KEYWORD, PHRASE_KEYWORD, UNORDERED_KEYWORDCustom Audience 관련 가능한 값: CUSTOM_AUDIENCE, CUSTOM_AUDIENCE_EXPANDED설치된 앱 스토어 카테고리 관련 가능한 값: APP_STORE_CATEGORY, APP_STORE_CATEGORY_LOOKALIKETwitter Audience Platform(TAP) 앱 제외: APP_LIST (operator_type=NE와 함께만 사용 가능) |
| targeting_value required | 선택한 targeting_type에 따라 어떤 사용자, 관심사, 위치, 이벤트, 플랫폼, 플랫폼 버전, 디바이스, 키워드 또는 구, 성별, Custom Audience, 앱 스토어 카테고리, 또는 앱 목록 제외에 이 타기팅을 적용할지 지정합니다.Type: string Example: 174958347 |
POST https://ads-api.x.com/12/accounts/18ce54d4x5t/targeting_criteria?line_item_id=619jl&targeting_type=BROAD_KEYWORD&targeting_value=technology
응답 예시
POST batch/accounts/:account_id/targeting_criteria
단일 요청으로 새로운 타기팅 기준(Targeting Criteria)을 일괄 생성할 수 있습니다. 배치 요청- 현재 최대 배치 크기는 500입니다.
- 모든 매개변수는 요청 본문으로 전송되며
Content-Type은application/json이어야 합니다. - 배치 요청은 하나의 그룹으로 함께 실패하거나 함께 성공하며, 오류와 성공을 포함한 모든 API 응답에서 초기 요청의 항목 순서가 유지됩니다.
- 요청 수준 오류(예: 최대 배치 크기 초과)는 응답의
errors객체 아래에 표시됩니다. - 항목 수준 오류(예: 필수 타기팅 기준 매개변수 누락)는 응답의
operation_errors객체 아래에 표시됩니다.
https://ads-api.x.com/12/batch/accounts/:account_id/targeting_criteria
매개변수
| 이름 | 설명 |
|---|---|
| operation_type 필수 | 각 항목에 대해 수행되는 작업 유형입니다. 유형: enum 가능한 값: Create, Delete |
| params 필수 | 타기팅 기준 객체에 대한 모든 매개변수를 포함하는 JSON 객체입니다. 필수 및 선택 매개변수 목록은 여기를 참조하세요. 또한 이 엔드포인트는 특정 targeting_type 값과 함께 사용하는 operator_type 매개변수를 지원합니다. 이 매개변수의 가능한 값은 같음을 의미하는 EQ, 크거나 같음을 의미하는 GTE, 작음을 의미하는 LT, 같지 않음을 의미하는 NE입니다. |
POST https://ads-api.x.com/12/batch/accounts/18ce54d4x5t/targeting_criteria
DELETE accounts/:account_id/targeting_criteria/:targeting_criterion_id
현재 계정에 속한 지정된 타깃팅 기준을 삭제합니다. Resource URLhttps://ads-api.x.com/12/accounts/:account_id/targeting_criteria/:targeting_criterion_id
Parameters
| Name | Description |
|---|---|
| account_id required | 사용 중인 계정의 식별자입니다. 리소스 경로에 포함되며, GET accounts를 제외한 대부분의 Advertiser API 요청에서 일반적으로 필수 매개변수입니다. 지정된 계정은 인증된 사용자와 연동되어 있어야 합니다. Type: string Example: 18ce54d4x5t |
| targeting_criterion_id required | 요청에서 대상으로 하는 타깃팅 기준을 가리키는 참조입니다. Type: string Example: dpl3a6 |
DELETE https://ads-api.x.com/12/accounts/18ce54d4x5t/targeting_criteria/dpl3a6
Example Response
타기팅 옵션
GET targeting_criteria/app_store_categories
Promoted Products에 사용할 수 있는 앱 스토어 카테고리 기반 타기팅 기준을 확인하세요. 앱 스토어 카테고리는 iOS App Store와 Google Play 스토어에서만 제공됩니다. 설치된 앱 카테고리 타기팅을 사용하면 사용자가 설치했거나 관심을 표시한 앱의 카테고리를 기준으로 타기팅할 수 있습니다. Resource URLhttps://ads-api.x.com/12/targeting_criteria/app_store_categories
Parameters
| Name | Description |
|---|---|
| q optional | 타기팅 기준을 범위 지정하기 위한 선택적 쿼리입니다. 이 파라미터를 생략하면 전체를 조회합니다. Type: string Example: music |
| os_type optional | 특정 앱 스토어로 결과를 제한합니다. Type: enum Possible values: ANDROID, IOS |
GET https://ads-api.x.com/12/targeting_criteria/app_store_categories?q=music&os_type=IOS
Example Response
GET targeting_criteria/conversations
프로모션 제품에서 사용할 수 있는 대화 기반 타기팅 기준을 확인합니다. Resource URLhttps://ads-api.x.com/12/targeting_criteria/conversations
Parameters
| Name | Description |
|---|---|
| conversation_type optional | 특정 대화 유형으로 범위를 한정하는 선택적 쿼리입니다. Type: enum Possible values: ACTORS, ATHLETES, BOOK_GENRES, BOOKS, BRAND_CATEGORIES, BRANDS, CELEBRITIES, COACHES, DIGITAL_CREATORS, ENTERTAINMENT_BRANDS, ENTERTAINMENT_PERSONALITIES, FICTIONAL_CHARACTERS, JOURNALISTS, LIFESTYLES, MOVIE_GENRES, MOVIES, MUSIC_GENRES, MUSICIANS, NEWS_STORIES, NEWS, PERSONS, PLACES, PODCASTS, POLITICAL_AFFILIATIONS, POLITICIANS, PRODUCTS, RADIO_STATIONS, SPORTS_LEAGUES, SPORTS_PERSONALITIES, SPORTS_TEAMS, SPORTS, TRENDS, TV_SHOWS, VIDEO_GAME_PLATFORMS, VIDEO_GAME_PUBLISHERS, VIDEO_GAMES |
| count optional | 각 요청마다 시도해 가져올 레코드 수를 지정합니다. Type: int Default: 200 Min, Max: 1, 1000 |
| cursor optional | 다음 페이지 결과를 가져오기 위한 커서를 지정합니다. 자세한 내용은 Pagination을 참조하세요. Type: string Example: 8x7v00oow |
GET https://ads-api.x.com/12/targeting_criteria/conversations?count=2
Example Response
GET targeting_criteria/devices
Promoted Products에 사용할 수 있는 기기 기반 타기팅 기준을 확인하세요. 기기 타기팅은 Promoted Tweets에 사용할 수 있습니다. Resource URLhttps://ads-api.x.com/12/targeting_criteria/devices
Parameters
| Name | Description |
|---|---|
| count optional | 각 요청에서 조회할 레코드 수를 지정합니다. Type: int Default: 200 Min, Max: 1, 1000 |
| q optional | 타기팅 기준을 범위 지정하기 위한 선택적 쿼리입니다. 이 매개변수를 생략하면 모두 조회됩니다. Type: string Example: apple |
GET https://ads-api.x.com/12/targeting_criteria/devices?count=2&q=iphone
Example Response
GET targeting_criteria/events
Promoted Products에 사용할 수 있는 이벤트 기반 타기팅 기준을 조회합니다. 라인 아이템당 타기팅할 수 있는 이벤트는 하나뿐입니다. 참고: 이벤트는 여러 시간대에 걸쳐 존재하는 경우가 많아, 서로 다른 시간대 관점에서 이벤트 시간을 고려할 때 복잡해질 수 있습니다. 이를 단순화하기 위해 이 엔드포인트의 모든 이벤트start_time 및 end_time 값은 이벤트의 로케일과 시간대와 무관하게 UTC±00:00으로 표기됩니다. 이벤트 start_time 및 end_time 값을 조회하고 사용할 때 이 설계를 염두에 두시기 바랍니다. 예를 들어, 미국 독립기념일은 UTC±00:00 기준으로 start_time=2017-07-04T00:00:00Z, end_time=2017-07-05T00:00:00Z로 표시되며, 이를 통해 해당 공휴일이 미국 내 여러 시간대에 걸쳐 존재하는 문제를 방지합니다.
Resource URL
https://ads-api.x.com/12/targeting_criteria/events
Parameters
| Name | Description |
|---|---|
| event_types required | 특정 이벤트 유형으로 범위를 제한하기 위한 선택적 쿼리입니다. Type: enum 가능한 값: CONFERENCE, HOLIDAY, MUSIC_AND_ENTERTAINMENT, OTHER, POLITICS, RECURRING, SPORTS |
| count optional | 각 요청에서 조회를 시도할 레코드 수를 지정합니다. Type: int Default: 200 Min, Max: 1, 1000 |
| country_codes optional | 특정 국가의 ISO 2자리 국가 코드를 사용해 타기팅 기준 검색 범위를 제한하기 위한 선택적 쿼리입니다. 이 매개변수를 지정하지 않으면 모든 이벤트가 반환됩니다. Type: string |
| cursor optional | 다음 페이지 결과를 가져오기 위한 커서를 지정합니다. 자세한 내용은 Pagination을 참조하세요. Type: string Example: 8x7v00oow |
| end_time optional | 캠페인이 종료되는 시간을 ISO 8601 형식으로 표현한 값입니다. Type: string Example: 2017-10-05T00:00:00Z |
| start_time optional | 라인 아이템이 게재를 시작하는 시간을 ISO 8601 형식으로 표현한 값입니다. 참고: 기본값은 현재 시간입니다. Type: string Example: 2017-07-05T00:00:00Z |
GET https://ads-api.x.com/12/targeting_criteria/events?count=1
Example Response
GET targeting_criteria/interests
Promoted Products용 관심사 기반 타기팅 기준을 확인하세요. 관심사는 자주 변경되지 않지만, 이 목록은 최소 주 1회 최신 상태로 갱신할 것을 권장합니다. Resource URLhttps://ads-api.x.com/12/targeting_criteria/interests
Parameters
| Name | Description |
|---|---|
| count optional | 각 요청당 조회할 레코드 수를 지정합니다. Type: int Default: 200 Min, Max: 1, 1000 |
| cursor optional | 다음 결과 페이지를 가져오기 위한 커서를 지정합니다. 자세한 내용은 Pagination을 참조하세요. Type: string Example: 8x7v00oow |
| q optional | 타기팅 기준을 범위 지정하기 위한 선택적 쿼리입니다. 전체를 가져오려면 이 매개변수를 생략하세요. Type: string Example: books |
GET https://ads-api.x.com/12/targeting_criteria/interests?q=books
Example Response
GET targeting_criteria/languages
타게팅에 사용할 수 있는 언어를 조회합니다. Resource URLhttps://ads-api.x.com/12/targeting_criteria/languages
Parameters
| Name | Description |
|---|---|
| count optional | 요청당 조회할 레코드 수를 지정합니다. Type: int Default: 200 Min, Max: 1, 1000 |
| cursor optional | 다음 페이지 결과를 가져오기 위한 커서를 지정합니다. 자세한 내용은 페이지네이션을 참조하세요. Type: string Example: 8x7v00oow |
| q optional | 타게팅 기준을 제한하기 위한 선택적 쿼리입니다. 전체를 가져오려면 이 매개변수를 생략하세요. Type: string Example: english |
GET https://ads-api.x.com/12/targeting_criteria/languages?q=english
Example Response
GET targeting_criteria/locations
Promoted Products에서 사용할 수 있는 위치 기반 타기팅 기준을 확인합니다. 지리적 타기팅은 국가, 주/지역, 도시, 우편번호 수준에서 Promoted Accounts 및 Promoted Tweets에 사용할 수 있습니다. 우편번호 단위의 분석을 조회하려면 우편번호 타기팅을 사용해야 합니다. 참고: San Francisco 또는 New York과 같은 특정 타기팅 가능 도시를 조회하려면location_type 요청 매개변수와 함께 CITIES 열거형을 사용하세요.
지정 시장 지역(DMA)을 타기팅하려면 METROS 열거형을 사용하세요.
Resource URL
https://ads-api.x.com/12/targeting_criteria/locations
Parameters
| Name | Description |
|---|---|
| count optional | 각 요청에서 조회할 레코드 수를 지정합니다. Type: int Default: 200 Min, Max: 1, 1000 |
| country_code optional | 2자리 ISO 국가 코드를 사용해 타기팅 기준 검색 범위를 특정 국가로 한정하는 선택적 쿼리입니다. 모든 국가의 결과를 조회하려면 이 매개변수를 생략하세요. Type: string Example: JP |
| cursor optional | 다음 페이지 결과를 가져오기 위한 커서를 지정합니다. 자세한 내용은 Pagination을 참조하세요. Type: string Example: 8x7v00oow |
| location_type optional | 특정 유형의 위치로 결과 범위를 한정합니다. COUNTRIES보다 더 세분화된 타기팅은 모든 위치에서 제공되지 않을 수 있습니다.Type: enum Possible values: COUNTRIES, REGIONS, METROS, CITIES, POSTAL_CODES |
| q optional | 타기팅 기준 검색 범위를 한정하는 선택적 쿼리입니다. 모든 결과를 조회하려면 이 매개변수를 생략하세요. Type: string Example: New York |
GET https://ads-api.x.com/12/targeting_criteria/locations?location_type=CITIES&q=los angeles
Example Response
GET targeting_criteria/network_operators
Promoted Products용 네트워크 사업자 기반 타기팅 기준을 확인합니다. 이 엔드포인트는 여러 국가에서 AT&T, Verizon, Sprint, T-Mobile 등과 같은 타기팅 가능한 통신사를 조회할 수 있도록 합니다. Resource URLhttps://ads-api.x.com/12/targeting_criteria/network_operators
Parameters
| Name | Description |
|---|---|
| count optional | 각 요청마다 조회할 레코드 수를 지정합니다. Type: int Default: 200 Min, Max: 1, 1000 |
| country_code optional | 2자리 ISO 국가 코드를 사용해 특정 국가로 타기팅 기준 검색 범위를 한정하는 선택적 쿼리입니다. 이 매개변수를 지정하지 않으면 미국 파트너 오디언스만 반환됩니다. Type: string Default: US |
| cursor optional | 다음 페이지 결과를 가져올 커서를 지정합니다. 자세한 내용은 Pagination을 참조하세요. Type: string Example: 8x7v00oow |
| q optional | 타기팅 기준 검색 범위를 한정하는 선택적 쿼리입니다. 모든 결과를 가져오려면 이 매개변수를 생략하세요. Type: string Examples: Airpeak |
GET https://ads-api.x.com/12/targeting_criteria/network_operators?count=5&country_code=US
Example Response
GET targeting_criteria/platform_versions
Promoted Products에서 사용할 수 있는 모바일 OS 버전 기반 타기팅 기준을 확인하세요. 플랫폼 버전 타기팅은 Promoted Accounts 및 Promoted Tweets에서 제공됩니다. 이를 통해 Android 8.0 또는 iOS 10.0처럼 모바일 운영체제 버전의 포인트 릴리스 단위까지 정밀 타기팅할 수 있습니다. Resource URLhttps://ads-api.x.com/12/targeting_criteria/platform_versions
Parameters
| Name | Description |
|---|---|
| q optional | 타기팅 기준 검색 범위를 지정하는 선택적 쿼리입니다. 모든 결과를 가져오려면 이 매개변수를 생략하세요. Type: string Examples: jelly bean |
GET https://ads-api.x.com/12/targeting_criteria/platform_versions
Example Response
GET targeting_criteria/platforms
Promoted Products에 대한 플랫폼 기반 타기팅 기준을 확인합니다. Resource URLhttps://ads-api.x.com/12/targeting_criteria/platforms
Parameters
| Name | Description |
|---|---|
| count optional | 각 요청별로 조회할 레코드 수를 지정합니다. Type: int Default: 200 Min, Max: 1, 1000 |
| q optional | 타기팅 기준 검색 범위를 지정하는 선택적 쿼리입니다. 모든 결과를 가져오려면 이 매개변수를 생략하세요. Type: string Examples: ios, blackberry |
| lang optional | ISO-639-1 언어 코드를 사용합니다. 전달되면 응답에 추가로 localized_name 속성이 반환됩니다. Type: int, string Example: fr |
GET https://ads-api.x.com/12/targeting_criteria/platforms
Example Response
GET targeting_criteria/tv_markets
TV 프로그램을 타겟팅할 수 있는 TV 마켓 목록을 확인합니다. 로캘별 마켓을 반환하며, 이를 사용해 GET targeting_criteria/tv_shows 엔드포인트를 조회할 수 있습니다. Resource URLhttps://ads-api.x.com/12/targeting_criteria/tv_markets
Parameters
없음
Example Request
GET https://ads-api.x.com/12/targeting_criteria/tv_markets
Example Response
GET targeting_criteria/tv_shows
Promoted Products에서 사용할 수 있는 TV 프로그램 기반 타기팅 기준을 확인합니다. TV 프로그램 타기팅은 일부 시장의 Promoted Tweets에서 제공됩니다. 사용 가능한 시장은 GET targeting_criteria/tv_markets 엔드포인트를 참조하세요. 참고: 1,000명 미만의 사용자가 포함된 오디언스는estimated_users 값이 1000으로 표시됩니다.
참고: TV 채널 및 장르 타기팅 옵션은 더 이상 지원되지 않습니다.
Resource URL
https://ads-api.x.com/12/targeting_criteria/tv_shows
Parameters
| Name | Description |
|---|---|
| locale required | 사용 가능한 TV 프로그램을 조회할 tv_market_locale을 지정하는 필수 매개변수입니다. TV 마켓은 GET targeting_criteria/tv_markets에서 반환되는 locale을 기준으로 조회됩니다.Type: string Example: en-US |
| count optional | 각 요청에서 조회할 레코드 수를 지정합니다. Type: int Default: 50 Min, Max: 1, 50 |
| cursor optional | 다음 결과 페이지를 가져오기 위한 커서를 지정합니다. 자세한 내용은 Pagination을 참조하세요. Type: string Example: 8x7v00oow |
| q optional | 타기팅 기준 검색 범위를 좁히는 선택적 쿼리입니다. 모든 결과를 가져오려면 이 매개변수를 생략하세요. Type: string Examples: ios, blackberry |
GET https://ads-api.x.com/12/targeting_criteria/tv_shows?locale=en-US&q=news&count=1
Example Response
타게팅 추천
GET accounts/:account_id/targeting_suggestions
초기 선택을 보완하기 위해 최대 50개의 키워드 또는 사용자 타기팅 제안을 가져옵니다. 리소스 URLhttps://ads-api.x.com/12/accounts/:account_id/targeting_suggestions
매개변수
| 이름 | 설명 |
|---|---|
| account_id 필수 | 사용하는 계정의 식별자입니다. 리소스 경로에 포함되며, GET accounts를 제외한 대부분의 Advertiser API 요청에서 일반적으로 필수 매개변수입니다. 지정된 계정은 인증된 사용자와 연결되어 있어야 합니다. 유형: string 예시: 18ce54d4x5t |
| suggestion_type 필수 | 반환할 제안의 유형을 지정합니다. 유형: enum 가능한 값: KEYWORD, USER_ID |
| targeting_values 필수 | 제안 생성을 위해 사용하는 키워드 또는 사용자 ID의 쉼표로 구분된 집합입니다. 참고: 두 유형의 제안을 혼합할 수 없습니다. 예시: 756201191646691328 |
| count 선택 | 각 요청에서 가져올 레코드 수를 지정합니다. 유형: int 기본값: 30 최소, 최대: 1, 50 |
GET https://ads-api.x.com/12/accounts/18ce54d4x5t/targeting_suggestions?suggestion_type=KEYWORD&targeting_values=developers&count=2"
응답 예시
세금 설정
GET accounts/:account_id/tax_settings
현재 계정에 연결된 세금 설정 상세 정보를 조회합니다. 리소스 URLhttps://ads-api.x.com/12/accounts/:account_id/tax_settings
매개변수
| 이름 | 설명 |
|---|---|
| account_id required | 사용 중인 계정의 식별자입니다. 리소스 경로에 포함되며, GET accounts를 제외한 모든 Advertiser API 요청에서 일반적으로 필수 매개변수입니다. 지정된 계정은 인증된 사용자와 연결되어 있어야 합니다. Type: string Example: 18ce54d4x5t |
GET https://ads-api.x.com/12/accounts/18ce54d4x5t/tax_settings
예시 응답
PUT accounts/:account_id/tax_settings
현재 계정의 세금 설정을 업데이트합니다. 리소스 URLhttps://ads-api.x.com/12/accounts/:account_id/tax_settings
매개변수
| 이름 | 설명 |
|---|---|
| account_id 필수 | 사용할 계정의 식별자입니다. 리소스 경로에 포함되며, GET accounts를 제외한 모든 광고주 API 요청에 필수 매개변수입니다. 지정된 계정은 인증된 사용자와 연결되어 있어야 합니다. 유형: string 예시: 18ce54d4x5t |
| address_city 선택 사항 | 계정 소유자 주소의 도시입니다. 유형: string 예시: San Francisco |
| address_country 선택 사항 | 계정 소유자 주소의 두 글자 국가 코드입니다. 유형: string 예시: US |
| address_email 선택 사항 | 계정 소유자 주소와 연결된 이메일입니다. 유형: string 예시: api@mctestface.com |
| address_first_name 선택 사항 | 계정 소유자 주소의 이름입니다. 유형: string 예시: API |
| address_last_name 선택 사항 | 계정 소유자 주소의 성입니다. 유형: string 예시: McTestface |
| address_name 선택 사항 | 계정 소유자 주소의 회사명입니다. 유형: string 예시: ABC, Co. |
| address_postal_code 선택 사항 | 계정 소유자 주소의 우편번호입니다. 유형: string 예시: 94102 |
| address_region 선택 사항 | 계정 소유자 주소의 지역입니다. 유형: string 예시: California |
| address_street1 선택 사항 | 계정 소유자 주소의 거리 주소입니다. 유형: string 예시: 21 March St |
| address_street2 선택 사항 | 계정 소유자 주소의 두 번째 거리 주소입니다. 유형: string 예시: Suite 99 |
| bill_to 선택 사항 | 청구 대상 주체입니다. 유형: enum 가능한 값: ADVERTISER, AGENCY |
| business_relationship 선택 사항 | 계정이 광고주 소유인지 대행사 소유인지 여부입니다. 유형: enum 가능한 값: AGENCY, SELF |
| client_address_city 선택 사항 | 광고주 주소의 도시입니다. 광고 계정이 대행사 소유인 경우 이 값을 설정합니다. 유형: string 예시: Toronto |
| client_address_country 선택 사항 | 광고주 주소의 두 글자 국가 코드입니다. 광고 계정이 대행사 소유인 경우 이 값을 설정합니다. 유형: string 예시: CA |
| client_address_email 선택 사항 | 광고주 주소와 연결된 이메일입니다. 광고 계정이 대행사 소유인 경우 이 값을 설정합니다. 유형: string 예시: ads@brand.com |
| client_address_first_name 선택 사항 | 광고주 주소의 이름입니다. 광고 계정이 대행사 소유인 경우 이 값을 설정합니다. 유형: string 예시: Brand |
| client_address_last_name 선택 사항 | 광고주 주소의 성입니다. 광고 계정이 대행사 소유인 경우 이 값을 설정합니다. 유형: string 예시: Advertiser |
| client_address_name 선택 사항 | 광고주 주소의 회사명입니다. 광고 계정이 대행사 소유인 경우 이 값을 설정합니다. 유형: string 예시: Brand, Inc. |
| client_address_postal_code 선택 사항 | 광고주 주소의 우편번호입니다. 광고 계정이 대행사 소유인 경우 이 값을 설정합니다. 유형: string 예시: M5H 2N2 |
| client_address_region 선택 사항 | 광고주 주소의 지역입니다. 광고 계정이 대행사 소유인 경우 이 값을 설정합니다. 유형: string 예시: Ontario |
| client_address_street1 선택 사항 | 광고주 주소의 거리 주소입니다. 광고 계정이 대행사 소유인 경우 이 값을 설정합니다. 유형: string 예시: 280 Queen St W |
| client_address_street2 선택 사항 | 광고주 주소의 두 번째 거리 주소입니다. 광고 계정이 대행사 소유인 경우 이 값을 설정합니다. 유형: string 예시: The 6 |
| invoice_jurisdiction 선택 사항 | 송장 관할권입니다. 유형: enum 가능한 값: LOI_SAPIN, NONE, NOT_SET |
| tax_category 선택 사항 | 과세 대상이 개인인지 사업자인지 여부입니다. 유형: enum 가능한 값: BUSINESS_NO_VAT, BUSINESS_WITH_VAT, INDIVIDUAL |
| tax_exemption_id 선택 사항 | VAT 면제 ID입니다. 유형: string 예시: 12345 |
| tax_id 선택 사항 | VAT 등록 ID입니다. 유형: string 가능한 값: 67890 |
PUT https://ads-api.x.com/12/accounts/18ce54d4x5t/tax_settings?address_name=ABC, Co.
응답 예시
GET accounts/:account_id/tracking_tags
현재 계정과 연결된 일부 또는 모든 추적 태그의 세부 정보를 조회합니다. Resource URLhttps://ads-api.x.com/12/accounts/:account_id/tracking_tags
Parameters
| Name | Description |
|---|---|
| account_id required | 사용 중인 계정의 식별자입니다. 리소스 경로에 포함되며 GET accounts를 제외한 모든 Advertiser API 요청에 일반적으로 필요한 매개변수입니다. 지정한 계정은 인증된 사용자와 연결되어 있어야 합니다. Type: string Example: 18ce54d4x5t |
| count optional | 각 요청에서 조회를 시도할 레코드 수를 지정합니다. Type: int Default: 200 Min, Max: 1, 1000 |
| cursor optional | 다음 결과 페이지를 가져오기 위한 커서를 지정합니다. 자세한 내용은 Pagination을 참조하세요. Type: string Example: 8x7v00oow |
| line_item_ids optional | 쉼표로 구분된 식별자 목록을 지정하여 특정 라인 아이템과 연결된 추적 태그만 응답에 포함하도록 범위를 제한합니다. 최대 200개의 ID를 제공할 수 있습니다. Type: string Example: 96uzp |
| sort_by optional | 지원되는 속성 기준으로 오름차순 또는 내림차순 정렬합니다. 자세한 내용은 Sorting을 참조하세요. Type: string Example: created_at-asc |
| tracking_tag_ids optional | 쉼표로 구분된 식별자 목록을 지정하여 원하는 추적 태그만 응답에 포함하도록 범위를 제한합니다. 최대 200개의 ID를 제공할 수 있습니다. Type: string Example: 3m82 |
| with_deleted optional | 삭제된 결과를 응답에 포함합니다. Type: boolean Default: false Possible values: true, false |
| with_total_count optional | total_count 응답 속성을 포함합니다.Note: 이 매개변수와 cursor는 상호 배타적입니다.Note: total_count를 포함하는 요청에는 더 낮은 요청 한도가 적용되며, 현재 15분당 200으로 설정되어 있습니다.Type: boolean Default: false Possible values: true, false |
GET https://ads-api.x.com/12/accounts/18ce54d4x5t/tracking_tags?tracking_tag_ids=3m82
Example Response
GET accounts/:account_id/tracking_tags/:tracking_tag_id
현재 계정에 연결된 특정 추적 태그를 조회합니다. Resource URLhttps://ads-api.x.com/12/accounts/:account_id/tracking_tags/:tracking_tag_id
Parameters
| Name | Description |
|---|---|
| account_id required | 사용 중인 계정의 식별자입니다. 리소스 경로에 포함되며, GET accounts를 제외한 모든 Advertiser API 요청에서 일반적으로 필수 매개변수입니다. 지정된 계정은 인증된 사용자와 연결되어 있어야 합니다. Type: string Example: 18ce54d4x5t |
| tracking_tag_id required | 해당 요청에서 대상으로 하는 추적 태그의 참조입니다. Type: string Example: 555j |
| with_deleted optional | 삭제된 결과를 포함할지 여부입니다. Type: boolean Default: false Possible values: true, false |
GET https://ads-api.x.com/12/accounts/18ce54d4x5t/tracking_tags/555j
Example Response
POST accounts/:account_id/tracking_tags
지정한 라인 아이템에 트래킹 태그를 연결합니다. 리소스 URLhttps://ads-api.x.com/12/accounts/:account_id/tracking_tags
매개변수
| Name | Description |
|---|---|
| account_id required | 사용 중인 계정의 식별자입니다. 리소스 경로에 포함되며 GET accounts를 제외한 모든 Advertiser API 요청에서 일반적으로 필수 매개변수입니다. 지정한 계정은 인증된 사용자와 연결되어 있어야 합니다. Type: string Example: 18ce54d4x5t |
| line_item_id required | 요청에서 작업 중인 라인 아이템에 대한 참조입니다. Type: string Example: 8v7jo |
| tracking_tag_type required | 트래킹 태그 유형입니다. Type: enum Possible value: IMPRESSION_TAG, CLICK_TRACKER |
| tracking_tag_url required | 트래킹 파트너가 제공한 트래킹 태그 URL입니다. Type: string Example: https://ad.doubleclick.net/ddm/trackimp/N1234.2061500TWITTER-OFFICIAL/B9156151.125630439;dc_trk_aid=1355;dc_trk_cid=8675309 |
POST https://ads-api.x.com/12/accounts/18ce54d4x5t/tracking_tags?line_item_id=fdwcl&tracking_tag_type=IMPRESSION_TAG&tracking_tag_url=https://ad.doubleclick.net/ddm/trackimp/N1234.2061500TWITTER-OFFICIAL/B9156151.125630439;dc_trk_aid=1355;dc_trk_cid=8675309
예시 응답
PUT accounts/:account_id/tracking_tags/:tracking_tag_id
지정된 라인 아이템에 추적 태그를 연결합니다. Resource URLhttps://ads-api.x.com/12/accounts/:account_id/tracking_tags/:tracking_tag_id
Parameters
| Name | Description |
|---|---|
| account_id required | 사용되는 계정의 식별자입니다. 리소스 경로에 포함되며, GET accounts를 제외한 모든 Advertiser API 요청에서 일반적으로 필요한 매개변수입니다. 지정된 계정은 인증된 사용자와 연결되어 있어야 합니다. Type: string Example: 18ce54d4x5t |
| tracking_tag_url required | 추적 파트너가 제공한 추적 태그 URL입니다. Type: string Example: https://ad.doubleclick.net/ddm/trackimp/N1234.2061500TWITTER-OFFICIAL/B9156151.125630439;dc_trk_aid=1355;dc_trk_cid=8675309 |
PUT https://ads-api.x.com/12/accounts/18ce54d4x5t/tracking_tags/3m82?tracking_tag_url=https://ad.doubleclick.net/ddm/trackimp/N1234.2061500TWITTER-OFFICIAL/B9156151.125630439;dc_trk_aid=1355;dc_trk_cid=8675309
Example Response
DELETE accounts/:account_id/tracking_tags/:tracking_tag_id
지정한 라인 아이템에서 트래킹 태그의 연결을 해제합니다. 리소스 URLhttps://ads-api.x.com/12/accounts/:account_id/tracking_tags/:tracking_tag_id
매개변수
| Name | Description |
|---|---|
| account_id required | 사용 중인 계정의 식별자입니다. 리소스 경로에 포함되며 GET accounts를 제외한 모든 Advertiser API 요청에서 일반적으로 필수 매개변수입니다. 지정한 계정은 인증된 사용자와 연동되어 있어야 합니다. Type: string Example: 18ce54d4x5t |
| tracking_tag_id required | 요청에서 작업 대상인 트래킹 태그를 가리키는 참조입니다. Type: string Example: 555j |
DELETE https://ads-api.x.com/12/accounts/18ce54d4x5t/tracking_tags/555j
응답 예시
사용자 설정
GET accounts/:account_id/user_settings/:user_id
사용자 설정을 가져옵니다. Resource URLhttps://ads-api.x.com/12/accounts/:account_id/user_settings/:user_id
Parameters
| Name | Description |
|---|---|
| account_id required | 활용 중인 계정의 식별자입니다. 리소스 경로에 포함되며, GET accounts를 제외한 모든 Advertiser API 요청에서 일반적으로 필수 매개변수입니다. 지정한 계정은 인증된 사용자와 연동되어 있어야 합니다. Type: string Example: 18ce54d4x5t |
| user_id required | 요청에서 작업 대상인 사용자를 참조합니다. 화면 이름의 사용자 ID를 조회하려면 GET users/lookup을 사용하세요. Type: long Example: 756201191646691328 |
GET https://ads-api.x.com/12/accounts/18ce54d4x5t/user_settings/756201191646691328
Example Response
PUT accounts/:account_id/user_settings/:user_id
사용자 설정을 업데이트합니다. 사용자 컨텍스트가 필요합니다. 계정 관리자는 접근할 수 없습니다. 리소스 URLhttps://ads-api.x.com/12/accounts/:account_id/user_settings/:user_id
매개변수
| Name | Description |
|---|---|
| account_id required | 사용 중인 계정의 식별자입니다. 리소스 경로와 GET accounts에 표시됩니다. 지정된 계정은 인증된 사용자와 연결되어 있어야 합니다. Type: string Example: 18ce54d4x5t |
| user_id required | 요청에서 조작 대상으로 하는 사용자를 참조합니다. 화면 이름에 대한 사용자 ID를 조회하려면 GET users/lookup을 사용하세요. Type: long Example: 756201191646691328 |
| notification_email optional | 계정 알림에 사용할 이메일 주소. Type: string Example: user@domain.com |
| contact_phone optional | 연락처 전화번호. Type: string Example: 202-555-0128 |
| contact_phone_extension optional | contact_phone의 내선 번호. Type: string Example: 1234 |
PUT https://ads-api.x.com/12/accounts/18ce54d4x5t/user_settings/756201191646691328?notification_email='user@domain.com'&subscribe_email_types=ACCOUNT_PERFORMANCE,PERFORMANCE_IMPROVEMENT"
예시 응답