참고 자료

이 참고 자료를 사용하여 POST /{catalog_id}/items_batch 엔드포인트와 POST /{catalog_id}/batch에 대해 지원되는 필드 및 각 예시를 확인하세요.

/{catalog_id}/batch/{catalog_id}/items_batch에 대한 매개변수 이름은 유사해 보이지만 각각 다른 매개변수입니다.

/{catalog_id}/items_batch API가 더 많은 사용 사례를 지원하고 적극적으로 관리되고 있으므로 이를 사용하는 것이 좋습니다.

지원되는 필드 - 품목 업데이트 전송 - /{catalog_id}/batch

이러한 필드는 CREATEUPDATE 메서드에 대해 지원됩니다.

필드 설정 해제

품목을 업데이트할 때 빈 문자열을 값으로 제공하여 선택적 필드의 설정을 해제하세요. 값을 null로 설정하면 필드 설정이 해제되지 않습니다.

필드 설명

additional_image_urls

유형:

array<string>

선택 사항.

최대 9~10개의 서로 다른 이미지에 대한 URL입니다.

additional_variant_attributes

유형:

list<KeyValue:string,string>

선택 사항.

에디션 그룹에서 제품을 구분하기 위한 추가 속성입니다.

예: {"Scent" : "Fruity", "Style" : "Classic"}

availability

유형: 문자열

필수 항목

구매 가능 여부 상태를 식별합니다.

  • in stock - 즉시 배송되는 품목
  • out of stock - 재고 보충 계획 없음
  • available for order - 1~2주 이내에 배송
  • discontinued

age_group

유형: 문자열

선택 사항.

나이가 동일하거나 비슷한 사람들로 구성된 그룹입니다. 허용되는 값은 newborn, infant, toddler, kids, adult입니다.

applinks

유형:

object<>

선택 사항.

모바일 앱에 대한 링크입니다.

category

유형: 문자열

선택 사항이지만 어드밴티지+ 카탈로그 광고에 권장합니다(광고 성과 개선에 도움이 될 수 있음). Instagram Shopping 및 페이지 Shops에 선택 사항이지만 해당 채널에서 사이트 내 결제를 활성화하려면 필수입니다(미국만 해당). Marketplace에 필수 항목입니다(미국만 해당).

품목의 Google 제품 카테고리(GPC)입니다. 여기에 나와 있는 카테고리의 분류 경로나 ID 번호를 사용합니다.

Instagram 또는 Facebook에서 결제를 사용하는 경우(미국에만 해당) 품목의 GPC가 세금과 반품 정책에 영향을 미칩니다. 카탈로그 품목에 대한 Google 제품 카테고리, 광고 지원 센터를 참조하세요.

예: Apparel & Accessories > Clothing > Shirts & Tops 또는 212

color

유형: 문자열

선택 사항.

최대 크기: 100.

품목 색상입니다.

condition

유형: 문자열

필수 항목.

품목 상태: new, refurbished, used입니다.

currency

유형: 문자열

필수 항목.

지정된 값에 대한 통화입니다. 마케팅 API는 광고 계정에서 지원하는 모든 통화를 지원합니다. 통화 표준에 ISO 4217을 사용하세요.

custom_label_0
custom_label_1
custom_label_2
custom_label_3
custom_label_4

유형: 문자열

선택 사항.

최대 문자 수 한도는 100자입니다.

품목에 대한 추가 정보입니다. 설정을 해제하려면 빈 문자열을 제공하세요.

description

유형: 문자열

필수 항목.

최대 크기: 5,000.

품목에 대한 짧은 설명입니다.

gender

유형: 문자열

선택 사항.

치수에 대한 성별입니다. 값에는 male, female, unisex가 포함됩니다.

gtin

유형: 문자열

선택 사항.

최대 크기: 70.

국제 무역 품목 번호에는 UPC,EAN, JANISBN이 포함될 수 있습니다.

image_url

유형: 문자열

필수 항목.

광고에 사용된 품목 이미지에 대한 링크입니다. 적절한 이미지 크기를 제공하세요.

단일 이미지 어드밴티지+ 카탈로그 광고의 경우

  • 최소 이미지 해상도 요구 사항은 500 * 500픽셀입니다.
  • 최소 가로세로비 요구 사항은 4:5입니다.
  • 최대 가로세로비 요구 사항은 1:91:1입니다.

이미지가 이 가로세로비를 벗어나는 경우 Facebook이 원본 가로세로비에 따라 최소 가로세로비 또는 최대 가로세로비에 가장 가깝게 이미지를 자릅니다.

슬라이드 이미지 어드밴티지+ 카탈로그 광고의 경우 - 최소 이미지 해상도 요구 사항은 500 * 500픽셀이고 Facebook이 이를 1:1 가로세로비로 자릅니다.

권장 사항: image url을 자주 바꾸지 마세요. price, timestamp 등의 매개변수는 수시로 변경되므로 이미지 URL에 포함해서는 안 됩니다.

inventory

유형: 숫자

선택 사항.

광고주가 인벤토리 수준에 대한 정보를 저장하는 데 사용할 수 있는 정수입니다.

marked_for_product_launch

유형: 문자열

어드밴티지+ 카탈로그 광고에는 해당 사항이 없습니다. 커머스에는 선택 사항입니다.

품목이 제품 출시에 사용될지 여부를 나타냅니다. 지원되는 값:

  • marked: 제품 출시가 생성될 때까지 품목이 구매자에게 보이지 않습니다. 그러면 원하는 출시 시간 전까지는 품목을 확인하거나 구매할 수 없습니다.
  • not_marked(기본값): 품목이 제품 출시에 포함되지 않습니다.

name

유형: 문자열

필수 항목.

최대 크기: 100.

품목 제목입니다.

pattern

유형: 문자열

선택 사항

최대 크기: 100.

품목의 패턴 또는 그래픽 프린트입니다.

price

유형: 정수

필수 항목.

모든 통화의 가격에 100을 곱한 가격입니다. 예: USD와 함께 사용할 경우 $4.90는 490으로 표시되고, JPY와 함께 사용할 경우 ¥490은 49000으로 표시됩니다.

product_type

유형: 문자열

선택 사항.

최대 크기: 750.

품목에 대해 판매점이 정의한 카테고리입니다.

예: TSV 가정 및 정원 > 주방 및 다이닝 > 가전제품 > 냉장고

예: XML product_type > 가정 및 정원 > 주방 및 다이닝 > 가전제품 > 냉장고 > product_type

retailer_product_group_id

유형: 문자열

선택 사항.

문자열을 허용합니다. 광고주가 제품을 함께 그룹화하는 데 사용할 수 있습니다.

sale_price

유형: 정수

선택 사항.

품목이 세일 중인 경우 할인가입니다. 모든 통화의 가격에 100을 곱한 할인 가격입니다. 예: USD와 함께 사용할 경우 $4.90는 490으로 표시되고, JPY와 함께 사용할 경우 ¥490은 49000으로 표시됩니다.

sale_price_start_date

유형: 문자열

선택 사항.

할인 종료 날짜 및 시간입니다.

예: 2014-12-01T00:00-0300

sale_price_end_date

유형: 문자열

선택 사항.

할인 시작 날짜 및 시간입니다.

예: 2014-11-01T12:00-0300

shipping

유형:

array<object>

선택 사항.

배송 정보입니다.

size

유형: 문자열

선택 사항.

품목 크기입니다. 예: Small 또는 XL.

url

유형: 문자열

필수 항목.

품목을 구매할 수 있는 판매자 사이트로 연결되는 링크입니다.

vendor_id

유형: 문자열

선택 사항.

품목을 판매하는 공급업체/판매자의 ID입니다.

요청 샘플 - /{catalog_id}/batch

{
  "access_token": "<ACCESS_TOKEN>",
  "requests": [
    {
      "method": "DELETE",
      "retailer_id": "retailer-1"
    },
    {
      "method": "CREATE",
      "retailer_id": "retailer-2",
      "data": {
        "availability": "in stock",
        "brand": "Nike",
        "category": "t-shirts",
        "description": "product description",
        "image_url": "http://www.images.example.com/t-shirts/1.png",
        "name": "product name",
        "price": 1000,
        "currency": "USD",
        "shipping": [
           {
              "country": "US",
              "region": "CA",
              "service": "service",
              "price_value": "10",
              "price_currency": "USD"
           }
        ],
        "condition": "new",
        "url":"http://www.images.example.com/t-shirts/1.png",
        "retailer_product_group_id": "product-group-1"
      },
      "applinks": {
          "android": [{
              "app_name": "Electronic Example Android",
              "package": "com.electronic",
              "url": "example-android://electronic"
              }],
          "ios": [{
              "app_name": "Electronic Example iOS",
              "app_store_id": 2222,
              "url": "example-ios://electronic"
              }]
      },
    },
    {
      "method": "UPDATE",
      "retailer_id": "retailer-3",
      "data": {
        "availability": "out of stock",
      }
    }
  ]
}

응답 샘플 - /{catalog_id}/batch

하나 또는 그 이상의 핸들이 반환됩니다.

"handles": ["AczwaOW7j_EuQ5peV3kGq8X9qc7cDiv_kFrrHkdKuG7LkpkkqK5939wgdoduSQ45FGK5vKdVqOaSDJEun-fvbsR1kk8Rd53AZyD1WThSemo26Q"]
https://graph.facebook.com/<API_VERSION>/<CATALOG_ID>/batch

지원되는 필드 - 제품 업데이트 전송 - /{catalog_id}/items_batch

커머스 카탈로그의 경우 — 1시간에 2회 이상 제품 정보를 업데이트해야 할 경우 이 API를 사용하세요(그러지 않을 경우 피드 API 사용). 단일 HTTP 요청에서 여러 품목을 업데이트할 수 있습니다.

PRODUCT_ITEM

이러한 제품 필드는 버전 3.3 및 3.2에서 CREATEUPDATE에 대해 지원됩니다.

필드설명

additional_image_link

유형:

array<string>

선택 사항.

최대 9~10개의 서로 다른 이미지에 대한 링크입니다.

additional_variant_attribute

유형:

list<KeyValue:string,string>

선택 사항.

에디션 그룹에서 제품을 구분하기 위한 추가 속성입니다.

예: "Scent:Fruity,Flavor:Apple"

age_group

유형: 문자열

선택 사항.

나이가 동일하거나 비슷한 사람들로 구성된 그룹입니다. 허용되는 값은 newborn, infant, toddler, kids, adult입니다.

applink

유형:

object<string>

선택 사항.

모바일 앱에 대한 링크입니다.

예:

"applink" : {
  "ios_url": "example-ios://electronic",
  "ios_app_store_id": "42",
  "ios_app_name": "Electronic Example iOS",
  "iphone_url": "example-iphone://electronic",
  "iphone_app_store_id": "43",
  "iphone_app_name": "Electronic Example iPhone",
  "ipad_url": "example-ipad://electronic",
  "ipad_app_store_id": "44",
  "ipad_app_name": "Electronic Example iPad",
  "android_url": "example-android://electronic",
  "android_package": "com.electronic",
  "android_class": "com.electronic.Example",
  "android_app_name": "Electronic Example Android",
  "windows_phone_url": "example-windows://electronic",
  "windows_phone_app_id": "64ec0d1b-5b3b-4c77-a86b-5e12d465edc0",
  "windows_phone_app_name": "Electronic Example Windows",
}

availability

유형: 문자열

필수 항목.

구매 가능 여부 상태를 식별합니다.

  • in stock - 즉시 배송되는 품목
  • out of stock - 재고 보충 계획 없음
  • available for order - 1~2주 이내에 배송
  • discontinued

brand

유형: 문자열

선택 사항.

품목의 브랜드입니다.

color

유형: 문자열

선택 사항.

최대 크기: 100.

품목 색상입니다.

condition

유형: 문자열

필수 항목.

제품 상태는 new, refurbished 또는 used입니다.

custom_label_0
custom_label_1
custom_label_2
custom_label_3
custom_label_4

유형: 문자열

선택 사항.

최대 문자 수 한도는 100자입니다.

품목에 대한 추가 정보입니다.

description

유형: 문자열

필수 항목.

최대 크기: 5,000.

제품을 설명하는 짧은 텍스트입니다.

disabled_capabilities

유형:

array<string>

선택 사항.

비활성화해야 할 기능의 리스트입니다. 가능한 값은 marketplace, b2c_marketplace, buy_on_facebook, cpas_parent_catalog, marketplace_shops, shops, daily_deals, ig_onsite_shopping, ig_product_tagging, c2c_marketplace, groups, profile, da, whatsapp, ldp, mini_shops, business_inbox_in_messenger, neighborhoods, test_capability입니다.

gender

유형: 문자열

선택 사항.

치수에 대한 성별입니다. 값에는 male, female, unisex가 포함됩니다.

google_product_category

유형: 문자열

선택 사항.

최대 크기: 250.

Google 제품 분류에서 사전 정의된 값(문자열 또는 카테고리 ID)입니다.

예: 의류 및 액세서리 > 의류 > 드레스 또는 2271.

gtin

유형: 문자열

선택 사항.

최대 크기: 70.

국제 무역 품목 번호(GTIN)에는 UPC, EAN, JANISBN이 포함될 수 있습니다.

id

유형: 문자열

필수 항목.

판매점 ID입니다.

image

유형: array <object>

광고 또는 Shop에서 사용할 이미지의 URL과 태그입니다. 최대 20개의 서로 다른 이미지를 지원합니다. 태그는 선택 사항이며 태그를 사용할 경우 이미지 내용을 설명해야 합니다.


예:

"image": [
      {
        "url":"http://example.com/image_1.jpg",
        "tag": ['Swimming pool','Gym'],
      }
]

image_link

유형: 문자열

image를 제공하는 경우 필수가 아닙니다.

대신 image를 사용하는 것이 좋습니다. image를 제공할 경우 image_linkadditional_image_link는 무시됩니다.

광고에 사용된 품목 이미지에 대한 링크입니다. 적절한 이미지 크기를 제공하세요.

단일 이미지 어드밴티지+ 카탈로그 광고의 경우:

  • 최소 이미지 해상도 요구 사항은 500 * 500픽셀입니다.
  • 최소 가로세로비 요구 사항은 4:5입니다.
  • 최대 가로세로비 요구 사항은 1:91:1입니다. 이미지가 이 가로세로비를 벗어나는 경우 Facebook이 원본 가로세로비에 따라 최소 가로세로비 또는 최대 가로세로비에 가장 가깝게 이미지를 자릅니다.

슬라이드 이미지 어드밴티지+ 카탈로그 광고의 경우: 최소 이미지 해상도 요구 사항은 500 * 500픽셀이고 Facebook이 1:1 가로세로비로 자릅니다.

internal_label

유형: 문자열

내부 레이블을 추가하여 제품 세트를 만들 때 항목 필터링에 도움을 받으세요. 예를 들어 여름맞이 세일에 포함되는 모든 제품에 '여름' 레이블을 추가한 다음 해당 제품을 하나의 세트로 필터링할 수 있습니다. 레이블은 만든 사람에게만 표시됩니다.

각 레이블을 작은따옴표(')로 묶고, 여러 레이블이 있으면 쉼표(,)로 구분합니다. 레이블의 시작 또는 끝에 공백을 포함하지 마세요. 글자 수 제한: 제품당 레이블 5,000개 이내, 레이블당 110자.

예(TSV, XLSX, Google 스프레드시트): ['summer','trending']

예(CSV): “['summer','trending']”

참고: 현재 제품 세트를 필터링하는 데 맞춤 레이블(custom_label_0~custom_label_4)을 사용하고 있다면 대신 내부 레이블(internal_label)로 전환하는 것을 권장합니다. 맞춤 레이블과 달리 필요에 따라 내부 레이블을 자주 추가하거나 업데이트할 수 있으며, 매번 제품을 보내 정책 검토를 거치지 않아도 되므로 광고 게재에 영향을 줄 수 있습니다.

이 필드의 이름은 이전에 product_tags였습니다. 이전 필드 이름도 지원하지만 새 이름을 사용하는 것이 좋습니다.

inventory

유형: 개체

선택 사항.

광고주가 인벤토리 수준에 대한 정보를 저장하는 데 사용할 수 있는 정수입니다.

item_group_id

유형: 문자열

선택 사항.

FBID가 아니라 광고주가 제공한 제품 그룹 ID입니다. 문자열을 허용합니다. 광고주가 다양한 개체(제품 품목, 차량, 호텔, 항공편 등)를 그룹화할 때 사용할 수 있습니다.

link

유형: 문자열

필수 항목.

품목을 구매할 수 있는 판매자 사이트로 연결되는 링크입니다.

manufacturer_part_number

유형: 문자열

선택 사항.

제품의 고유한 제조업체 ID입니다.

pattern

유형: 문자열

선택 사항.

최대 크기: 100.

제품의 패턴 또는 그래픽 프린트입니다.

price

유형: 문자열

필수 항목.

품목 가격입니다. 가격 형식은 비용 뒤에 3자리 ISO 통화 코드를 붙이고 비용과 통화 사이에 공백이 있어야 합니다.

예: 9.99 USD.

rating_count

유형: 숫자

선택 사항.

이 제품에 대해 구매자가 제공한 평가 수입니다. 0보다 커야 합니다. user_rating과 함께 사용해야 합니다.

예: 100

sale_price

유형: 문자열

선택 사항이지만 어드밴티지+ 카탈로그 광고에 오버레이 기능을 사용하려면 필수입니다.

품목이 세일 중인 경우 할인된 가격입니다. 가격 형식은 비용 뒤에 3자리 ISO 통화 코드를 붙이고 비용과 통화 사이에 공백이 있어야 합니다.

예: 9.99 USD, 25.00 EUR

sale_price_effective_date

유형: 문자열

선택 사항.

슬래시(/)로 구분된 할인 시작 및 종료 일시입니다. 시작 및 끝 날짜는 YYYY-MM-DD 형식으로 작성합니다. 각 날짜 뒤에 'T'를 추가한 후 시간을 포함합니다. 시간은 24시간 형식(0:00~23:59)으로 작성하세요.

예: 2014-11-01T12:00-0300/2014-12-01T00:00-0300.

shipping

유형: 문자열

선택 사항.

국가 및 지역별로 다른 가격이 포함된 블롭입니다. 각 지역은 쉼표로 구분됩니다. COUNTRY:STATE:SHIPPING_TYPE:PRICE 형식이어야 합니다.

예: US:CA:Ground:9.99 USD, US:NY:Air:15.99 USD

size

유형: 문자열

선택 사항.

품목 크기입니다. 예: Small 또는 XL.

title

유형: 문자열

필수 항목.

최대 크기: 100.

품목 제목입니다.

user_rating

유형: 숫자

선택 사항.

이 제품에 대해 구매자가 제공한 평균 평가입니다. 범위는 1.0~5.0입니다. 소수점 한 자리까지 허용됩니다. rating_count와 함께 사용해야 합니다.

예: 4.5

video

유형: array <object>

광고 또는 Shop에서 사용할 동영상의 URL과 태그입니다. 카탈로그 수준에서 최대 30,000개의 동영상을 지원합니다. 태그는 선택 사항이며 태그를 사용할 경우 동영상 내용을 설명해야 합니다.


최대 동영상 파일 크기는 200MB입니다. 지원되는 형식에는 .3g2, .3gp, .3gpp, .asf, .avi, .dat, .divx, .dv, .f4v, .flv, .gif, .m2ts, .m4v, .mkv, .mod, .mov, .mp4, .mpe, .mpeg, .mpeg4, .mpg, .mts, .nsv, .ogm, .ogv, .qt, .tod, .ts, .vob, .wmv 등이 포함됩니다.


예:

"video": [
      {
        "url":"http://example.com/video_1.mp4",
        "tag": ['Swimming pool','Gym'],
      }
]

참고: 제품에 동영상 1, 2가 있는 경우 동영상 1을 삭제하려면 배열에서 동영상 1을 삭제하세요.

[
  {
    "method": "UPDATE",
    "data": {
      "video": [
        {
          "url": "https://google.com/video_2.mp4",
          "tag": ["video_2"]
        }
      ]
    }
  }
]

모든 동영상을 삭제하려면 빈 배열을 보내세요.

[
  {
    "method": "UPDATE",
    "data": {
      "video": []
    }
  }
]

UPDATE 메서드는 품목이 존재하지 않는 경우 품목을 만드는 데 사용할 수도 있습니다.

제품 필드에 대한 자세한 내용은 API 참고 자료를 참조하세요.

요청 샘플 - PRODUCT_ITEM

curl \
  -d @body.json \
  -H "Content-Type: application/json"

  {
    "access_token": "<ACCESS_TOKEN>",
    "item_type": "PRODUCT_ITEM",
    "requests": [
      {
        "method": "DELETE",
        "data": {
          "id": "retailer-1"
        }
      },
      {
        "method": "CREATE",
        "data": {
          "id": "retailer-2",
            "applink" : {
            "ios_url":"example-ios://electronic",
            "ios_app_store_id":"42",
            "ios_app_name":"Electronic Example iOS",
            "iphone_url":"example-iphone://electronic",
            "iphone_app_store_id":"43",
            "iphone_app_name":"Electronic Example iPhone",
            "ipad_url":"example-ipad://electronic",
            "ipad_app_store_id":"44",
            "ipad_app_name":"Electronic Example iPad",
            "android_url":"example-android://electronic",
            "android_package":"com.electronic",
            "android_class":"com.electronic.Example",
            "android_app_name":"Electronic Example Android",
            "windows_phone_url":"example-windows://electronic",
            "windows_phone_app_id":"64ec0d1b-5b3b-4c77-a86b-5e12d465edc0",
            "windows_phone_app_name":"Electronic Example Windows",
          },
          "availability": "in stock",
          "brand": "Nike",
          "google_product_category": "t-shirts",
          "description": "product description",
          "image_link": "http://www.images.example.com/t-shirts/1.png",
          "title": "product name",
          "price": "10.00 USD",
          "shipping": [
               {
                  "shipping_country": "US",
                  "shipping_region": "CA",
                  "shipping_service": "service",
                  "shipping_price_value": "10",
                  "shipping_price_currency": "USD"
               }
          ],
          "condition": "new",
          "link":"http://www.images.example.com/t-shirts/1.png",
          "item_group_id": "product-group-1"
        }
      },
      {
        "method": "UPDATE",
        "data": {
          "availability": "out of stock",
          "id": "retailer-3",
        }
      }
    ]
  }

응답 샘플 - PRODUCT_ITEM

{
  // One or more handles will be returned"handles": ["AczwaOW7j_EuQ5peV3kGq8X9qc7cDiv_kFrrHkdKuG7LkpkkqK5939wgdoduSQ45FGK5vKdVqOaSDJEun-fvbsR1kk8Rd53AZyD1WThSemo26Q"]
}

데이터 피드를 포함하여 카탈로그 품목 추가에 대해 자세히 알아보세요.


HOTEL

버전 3.2에서 HOTEL 유형의 CREATEUPDATE 메서드에 대해 지원되는 제품 필드:

필드설명

address

유형:

object<string>

필수 항목.

호텔 주소입니다.

applink

유형:

선택 사항.

모바일 앱에 대한 링크입니다.

base_price

유형: 문자열

필수 항목.

호텔 객실의 1박 기본 가격입니다. 가격에 통화 유형을 추가합니다. 가격 형식은 비용 뒤에 ISO 통화 코드를 붙이고 비용과 통화 사이에 공백이 있어야 합니다. 예: 미국 달러의 경우 USD.

brand

유형: 문자열

선택 사항.

호텔 체인의 브랜드 정보입니다.

custom_label_0
custom_label_1
custom_label_2
custom_label_3
custom_label_4

유형: 문자열

최대 문자 수 한도: 100

세트를 만들 때 상품 필터링 기준으로 사용하려는 추가 정보에 대한 최대 5개의 맞춤 필드입니다. 예를 들어 맞춤 필드를 사용하여 여름맞이 세일에 포함되는 모든 객실을 표시한 다음 해당 객실을 하나의 세트로 필터링할 수 있습니다. 이 필드에는 숫자를 포함한 모든 텍스트 값을 사용할 수 있습니다.


예: Summer Sale

이 필드는 보조 피드에서 지원합니다.

custom_number_0
custom_number_1
custom_number_2
custom_number_3
custom_number_4

유형: 정수

세트를 만들 때 상품 필터링 기준으로 사용하려는 추가 숫자 관련 정보에 대한 최대 5개의 맞춤 필드입니다. 이 필드를 사용하면 세트를 만들 때 숫자 범위(보다 큼보다 작음)를 기준으로 필터링할 수 있습니다. 예를 들어 이 필드를 사용하여 호텔이 개장한 연도를 표시한 다음 특정 연도 범위를 하나의 세트로 필터링할 수 있습니다.


이 필드에는 0~4294967295의 정수를 사용할 수 있습니다. 음수, 소수 또는 쉼표는 사용할 수 없습니다(예: -2, 5.5 또는 10,000).


예: 2022

description

유형: 문자열

필수 항목.

최대 글자 수 제한: 5,000자.

호텔에 대한 간단한 설명입니다.

guest_rating

유형:

array<object>

선택 사항.

호텔에 대한 손님의 평가입니다.

hotel_id

유형: 문자열

필수 항목.

호텔의 고유한 ID입니다.

image

유형:

array<object>

필수 항목.

광고에 사용할 이미지의 URL 및 태그입니다. 최대 20개의 복수 이미지를 지원합니다. 태그는 사용할 경우 선택 사항입니다. 이미지 내용을 설명해야 합니다. 예: "reception".

latitude

유형: 문자열

필수 항목.

호텔의 위도입니다.

longitude

유형: 문자열

필수 항목.

호텔의 경도입니다.

loyalty_program

유형: 문자열

선택 사항.

호텔에 사용하는 회원 혜택 프로그램입니다.

margin_level

유형: 문자열

선택 사항.

호텔의 수익성을 나타내는 지표입니다(값 범위: 1~10).

name

유형: 문자열

필수 항목.

호텔 이름입니다.

neighborhood

유형:

array<string>

선택 사항.

하나 이상의 호텔 주변 지역입니다. 예: Soho 또는 Las Vegas Strip. 허용되는 최대 동네 수: 20.

phone

유형: 문자열

선택 사항.

국가 번호를 포함한 전화번호입니다.

sale_price

유형: 문자열

선택 사항.

호텔의 1박 할인 가격입니다. 이 가격을 사용하여 일반 호텔 가격의 할인을 광고합니다. 필수 항목: 가격에 통화 유형을 추가합니다. 가격 형식은 비용 뒤에 ISO 통화 코드를 붙이고 비용과 통화 사이에 공백이 있어야 합니다. 예: 미국 달러의 경우 USD.

star_rating

유형: 문자열

선택 사항.

호텔의 별 평점입니다. 숫자는 1~5 사이여야 합니다.

url

유형: 문자열

필수 항목.

호텔 객실을 예약할 수 있는 외부 사이트에 대한 링크입니다.

UPDATE 메서드는 품목이 존재하지 않는 경우 품목을 만드는 데 사용할 수도 있습니다.

요청 샘플 - HOTEL

curl \
  -d @body.json \
  -H "Content-Type: application/json"

  {
    "access_token": "<ACCESS_TOKEN>",
    "item_type": "HOTEL",
    "requests": [
      {
        "method": "DELETE",
        "data": {
          "hotel_id": "hotel-1"
        }
      },
      {
        "method": "CREATE",
        "data": {
          "hotel_id": "1234",
          "brand": "Premium_brand",
          "description": "A very nice hotel",
          "name": "The best hotel",
          "base_price": "100.00 USD",
          "longitude":"42.10",
          "latitude":"42.10",
          "address": {
              "addr1":"100 Main Street",
              "city":"North Pole",
              "region":"ABC",
              "country":"US",
              "postal_code":"11111"
          },
          "guest_rating" : [
            {
                "rating_system":"tripAdvisor",
                "score":"7.8",
                "number_of_reviewers":"300",
                "max_score":"10",
            },
            {
                "rating_system":"Yelp",
                "score":"5.1",
                "number_of_reviewers":"123",
                "max_score":"10",
            },
          ],
          "image": [
            {
                "url":"http://example.com/image_1.jpg",
                "tag": ['Swimming pool','Gym'],
            }
          ],
          "applink" : {
            "ios_url":"example-ios://electronic",
            "ios_app_store_id":"42",
            "ios_app_name":"Electronic Example iOS",
            "iphone_url":"example-iphone://electronic",
            "iphone_app_store_id":"43",
            "iphone_app_name":"Electronic Example iPhone",
            "ipad_url":"example-ipad://electronic",
            "ipad_app_store_id":"44",
            "ipad_app_name":"Electronic Example iPad",
            "android_url":"example-android://electronic",
            "android_package":"com.electronic",
            "android_class":"com.electronic.Example",
            "android_app_name":"Electronic Example Android",
            "windows_phone_url":"example-windows://electronic",
            "windows_phone_app_id":"64ec0d1b-5b3b-4c77-a86b-5e12d465edc0",
            "windows_phone_app_name":"Electronic Example Windows",
          },
          "loyalty_program":"Premium_program",
          "margin_level": "8",
          "phone":"+61 2-96027455",
          "star_rating":"4",
          "url":"http://www.images.example.com/t-shirts/1.png"
        }
      },
      {
        "method": "UPDATE",
        "data": {
          "base_price": "90.00 USD",
          "hotel_id": "hotel-3",
        }
      }
    ]
  }

응답 샘플 - HOTEL

{
  // One or more handles will be returned"handles": ["AczwaOW7j_EuQ5peV3kGq8X9qc7cDiv_kFrrHkdKuG7LkpkkqK5939wgdoduSQ45FGK5vKdVqOaSDJEun-fvbsR1kk8Rd53AZyD1WThSemo26Q"]
}

HOTEL_ROOM

이러한 제품 필드는 버전 3.2에서 HOTEL_ROOM 유형의 CREATEUPDATE 메서드에 대해 지원됩니다.

필드설명

base_price

유형: 문자열

필수 항목.

1박 기본 가격입니다. 통화는 ISO 4217 통화 코드를 따라야 합니다.

예: 9.99 USD.

description

유형: 문자열

필수 항목.

최대 크기: 5,000.

객실을 설명하는 짧은 텍스트입니다.

hotel_retailer_id

유형: 문자열

필수 항목.

호텔 판매점의 고유한 ID입니다.

hotel_room_id

유형: 문자열

필수 항목.

호텔의 고유한 ID입니다.

image

유형:

array<object>

필수 항목.

객실 이미지입니다.

name

유형: 문자열

필수 항목.

최대 크기: 100.

객실 이름입니다.

url

유형: 문자열

필수 항목.

사용자가 투숙을 예약할 수 있는 광고주 웹사이트 링크입니다.

UPDATE 메서드는 품목이 존재하지 않는 경우 품목을 만드는 데 사용할 수도 있습니다.

요청 샘플 - HOTEL_ROOM

curl \
  -d @body.json \
  -H "Content-Type: application/json"

  {
    "access_token": "<ACCESS_TOKEN>",
    "item_type": "HOTEL_ROOM",
    "requests": [
      {
        "method": "DELETE",
        "data": {
          "hotel_retailer_id": "1234",
          "hotel_room_id": "room-1",
        }
      },
      {
        "method": "CREATE",
        "data": {
          "hotel_retailer_id": "1234",
          "hotel_room_id": "room-2",
          "description": "product description",
          "name": "product name",
          "base_price": "100 USD",
          "url": "http://www.example.com/t-shirts/1.html",
          "image": [
            {
                "url":"http://example.com/image_1.jpg",
                "tag": ['Swimming pool','Gym'],
            }
          ]
      },
      {
        "method": "UPDATE",
        "data": {
          "hotel_retailer_id": "1234",
          "hotel_room_id": "room-3",
          "base_price": "120 USD",
        }
      }
    ]
  }

응답 샘플 - HOTEL_ROOM

{
    // One or more handles will be returned"handles": ["AczwaOW7j_EuQ5peV3kGq8X9qc7cDiv_kFrrHkdKuG7LkpkkqK5939wgdoduSQ45FGK5vKdVqOaSDJEun-fvbsR1kk8Rd53AZyD1WThSemo26Q"]
  }

FLIGHT

이러한 제품 필드는 버전 3.2에서 FLIGHT 유형의 CREATEUPDATE 메서드에 대해 지원됩니다.

필드설명

description

유형: 문자열

선택 사항.

최대 글자 수 제한: 5,000자.

항공편에 대한 설명입니다.

destination_airport

유형: 문자열

필수 항목.

항공편의 목적지 공항입니다. IATA 코드 형식으로 작성해야 합니다.

예: SFO.

destination_city

유형: 문자열

선택 사항.

항공편의 목적지 도시 이름입니다.

image

유형:

array<object>

필수 항목.

광고에 사용할 이미지의 URL 및 태그입니다. 최대 20개의 복수 이미지를 지원합니다. 태그는 선택 사항이며 태그를 사용할 경우 이미지 내용을 설명해야 합니다.

예: seat

origin_airport

유형: 문자열

필수 항목.

항공편의 출발 공항입니다. IATA 코드 형식으로 작성해야 합니다.

예: SFO

origin_city

유형: 문자열

선택 사항.

항공편의 출발 도시 이름입니다.

price

유형: 문자열

선택 사항.

항공편의 비용 및 통화입니다. 가격 형식은 숫자 뒤에 통화 코드를 붙여 지정합니다. ISO 4217 표준을 사용하세요. 가격에서 '.'를 소수점으로 사용하세요.

url

유형: 문자열

선택 사항.

항공편을 예약할 수 있는 웹사이트의 링크입니다.

UPDATE 메서드는 품목이 존재하지 않는 경우 품목을 만드는 데 사용할 수도 있습니다.

요청 샘플 - FLIGHT

curl \
  -d @body.json \
  -H "Content-Type: application/json"

  {
    "access_token": "<ACCESS_TOKEN>",
    "item_type": "FLIGHT",
    "requests": [
      {
        "method": "DELETE",
        "data": {
          "origin_airport": "BOS",
          "destination_airport": "JFK",
        }
      },
      {
        "method": "CREATE",
        "data": {
          "origin_airport": "BOS",
          "destination_airport": "SFO",
          "description": "Best Flight to SFO",
          "image": [
            {
                "url":"http://example.com/image_1.jpg",
                "tag": ['City'],
            },
            {
                "url":"http://example.com/some.image_2.jpg",
                "tag": ['Food'],
            }
          ],
          "price":"100.00 USD",
        }
      },
      {
        "method": "UPDATE",
        "data": {

응답 샘플 - FLIGHT

{
    // One or more handles will be returned"handles": ["AczwaOW7j_EuQ5peV3kGq8X9qc7cDiv_kFrrHkdKuG7LkpkkqK5939wgdoduSQ45FGK5vKdVqOaSDJEun-fvbsR1kk8Rd53AZyD1WThSemo26Q"]
  }

DESTINATION

이러한 제품 필드는 버전 3.2에서 DESTINATION 유형의 CREATEUPDATE 메서드에 대해 지원됩니다.

필드설명

applink

유형:

object<string>

선택 사항.

모바일 앱에 대한 링크입니다.

address

유형:

object<string>

필수 항목.

호텔 주소입니다.

description

유형: 문자열

선택 사항.

최대 글자 수 제한: 5,000자.

목적지를 설명하는 짧은 단락입니다.

destination_id

유형: 문자열

필수 항목.

최대 글자 수 제한: 100자.

목적지의 고유한 ID입니다.

image

유형:

array<object>

필수 항목.

광고에 사용할 이미지의 URL 및 태그입니다. 최대 20개의 복수 이미지를 지원합니다. 태그는 선택 사항이며 태그를 사용할 경우 이미지 내용을 설명해야 합니다.

예: seat.

latitude

유형: 문자열

필수 항목.

목적지의 위도입니다.

longitude

유형: 문자열

필수 항목.

목적지의 경도입니다.

name

유형: 문자열

필수 항목.

목적지 이름입니다.

neighborhood

유형:

array<string>

선택 사항.

허용되는 최대 동네 수: 20. 하나 이상의 목적지 주변 지역입니다.

예: Soho 또는 Las Vegas Strip.

price

유형: 문자열

선택 사항.

목적지의 최저 평균 비용 및 통화입니다. 가격 형식은 숫자 뒤에 통화 코드를 붙여 지정합니다. ISO 4217 표준을 사용하세요. 가격에서 '.'를 소수점으로 사용하세요.

price_change

유형: 문자열

선택 사항.

가격 변동입니다. 제품 세트 빌드 및 광고 크리에이티브에 사용할 수 있습니다.

  • 0 - 가격 변동 없음
  • -10 - 10% 가격 인하
  • 20 - 20% 가격 인상

예: '뉴욕시 평균 가격 X 하락' 또는 '뉴욕시 평균 가격 하락'

type

유형:

array<string>

필수 항목.

목적지 유형의 최대 개수: 20. 목적지 유형입니다. 목적지는 여러 유형을 가질 수 있습니다.

예: park 또는 beach

url

유형: 문자열

필수 항목.

목적지를 예약할 수 있는 웹사이트의 링크입니다.

UPDATE 메서드는 품목이 존재하지 않는 경우 품목을 만드는 데 사용할 수도 있습니다.

요청 샘플 - DESTINATION

curl \
  -d @body.json \
  -H "Content-Type: application/json"

  {
    "access_token": "<ACCESS_TOKEN>",
    "item_type": "DESTINATION",
    "requests": [
      {
        "method": "DELETE",
        "data": {
          "destination_id": "destination-1"
        }
      },
      {
        "method": "CREATE",
        "data": {
          "destination_id": "123456789",
          "description": "My destination is the best.",
          "name": "The best destination",
          "price": "199.00 USD",
          "price_change": "-20",
          "longitude":"-122.4424",
          "latitude":"37.7712",
          "image": [
            {
                "url":"http://example.com/image_1.jpg",
                "tag": ['City','Package'],
            },
            {
                "url":"http://example.com/some.image_2.jpg",
                "tag": ['Tour','Landmark'],
            }
          ],
          "address": {
              "addr1":"1 Market Street",
              "city":"San Francisco",
              "region":"California",
              "country":"United States",
              "postal_code":"94117"
          },
          "applink" : {
            "ios_url":"example-ios://travelapp",
            "ios_app_store_id":"42",
            "ios_app_name":"Travel App iOS",
            "iphone_url":"example-iphone://travelapp",
            "iphone_app_store_id":"43",
            "iphone_app_name":"Travel App iPhone",
            "ipad_url":"example-ipad://travelapp",
            "ipad_app_store_id":"44",
            "ipad_app_name":"Travel App iPad",
            "android_url":"example-android://travelapp",
            "android_package":"com.travelapp",
            "android_class":"com.travelapp.Example",
            "android_app_name":"Travel App Android",
            "windows_phone_url":"example-windows://travelapp",
            "windows_phone_app_id":"64ec0d1b-5b3b-4c77-a86b-5e12d465edc0",
            "windows_phone_app_name":"Travel App Windows",
          },
          "type":["city","culture"],
          "neighborhood":["Mission","SoMa"],
          "url":"http://www.thebestdestination.com"
        }
      },
      {
        "method": "UPDATE",
        "data": {
          "price": "159.99",
          "destination_id": "destination-3",
        }
      }
    ]
  }

응답 샘플 - DESTINATION

{
  // One or more handles will be returned"handles": ["AczwaOW7j_EuQ5peV3kGq8X9qc7cDiv_kFrrHkdKuG7LkpkkqK5939wgdoduSQ45FGK5vKdVqOaSDJEun-fvbsR1kk8Rd53AZyD1WThSemo26Q"]
}

HOME_LISTING

이러한 제품 필드는 버전 3.3 및 3.2에서 HOME_LISTING 유형의 CREATEUPDATE 메서드에 대해 지원됩니다.

필드설명

applink

유형:

object<string>

선택 사항.

모바일 앱에 대한 링크입니다.

address

유형:

object<string>

필수 항목.

주택 매물의 상세 주소입니다.

availability

유형: 문자열

필수 항목.

주택 매물의 현재 구매 가능 여부입니다. 지원되는 값은 for_sale, for_rent, sale_pending, recently_sold, off_market, available_soon입니다.

available_dates_price_config

유형:

array<object>

선택 사항.

가격 구성입니다.

description

유형: 문자열

선택 사항.

최대 글자 수 제한: 5,000자.

주택 매물을 설명하는 짧은 단락입니다.

image

유형:

array<object>

필수 항목.

광고에 사용할 이미지의 URL 및 태그입니다. 최대 20개의 복수 이미지를 지원합니다. 태그는 선택 사항이며 태그를 사용할 경우 이미지 내용을 설명해야 합니다.

예: pool.

latitude

유형: 문자열

선택 사항.

주택 매물의 위도입니다.

longitude

유형: 문자열

선택 사항.

주택 매물의 경도입니다.

listing_type

유형: 문자열

선택 사항.

매물 유형입니다. 지원되는 값은 for_rent_by_agent, for_rent_by_owner, for_sale_by_agent, for_sale_by_owner, foreclosed, new_construction, new_listing입니다.

name

유형: 문자열

필수 항목.

주택 매물의 이름입니다.

neighborhood

유형:

array<object>

선택 사항.

주택 매물의 주변 지역입니다. 허용되는 최대 동네 수: 20.

num_baths

유형: 문자열

선택 사항.

욕실 개수입니다.

num_beds

유형: 문자열

선택 사항.

침실 개수입니다.

num_units

유형: 문자열

선택 사항.

사용 가능한 유닛 수입니다. 렌트/임대 가능한 아파트 또는 콘도에만 사용합니다.

price

유형: 문자열

필수 항목.

주택 매물의 비용 및 통화입니다. 가격 형식은 숫자 뒤에 통화 코드를 붙여 지정합니다. ISO 4217 표준을 사용하세요. 가격에서 '.'를 소수점으로 사용하세요.

price_change

유형: 문자열

선택 사항.

가격 변동입니다. 제품 세트 빌드 및 광고 크리에이티브에 사용할 수 있습니다.

  • 0 - 가격 변동 없음
  • -10 - 10% 가격 인하
  • 20 - 20% 가격 인상

예: '뉴욕시 평균 가격 X 하락' 또는 '뉴욕시 평균 가격 하락'

property_type

유형: 문자열

선택 사항.

부동산 유형입니다. 지원되는 값은 apartment, condo, house, land, manufactured, other, townhouse입니다.

url

유형: 문자열

필수 항목.

매물을 볼 수 있는 웹사이트의 링크입니다.

year_built

유형: 문자열

선택 사항.

주택이 지어진 연도입니다.

UPDATE 메서드는 품목이 존재하지 않는 경우 품목을 만드는 데 사용할 수도 있습니다.

요청 샘플 - HOME_LISTING

{
  "access_token": "<ACCESS_TOKEN>",
  "item_type": "HOME_LISTING",
  "requests": [
    {
      "method": "DELETE",
      "data": {
        "home_listing_id": "home-listing-1"
      }
    },
    {
      "method": "CREATE",
      "data": {
        "home_listing_id": "12345678",
        "availability": "for_sale",
        "description": "An amazing listing",
        "name": "1 Hacker Way, Menlo Park, CA 94025",
        "price": "110000 USD",
        "longitude":"1.11414",
        "latitude":"-1.835003",
        "address": {
            "addr1":"1 Hacker Way",
            "city":"Menlo Park",
            "region":"California",
            "country":"United States",
            "postal_code":"94025"
        },
        "neighborhood":["Menlo Oaks"],
        "image": [
          {
              "url":"http://img10.naventcdn.com/avisos/18/00/52/30/31/52/1200x1200/63590918.jpg",
          },
        ],
        "listing_type": "for_sale_by_agent",
        "num_baths":"6",
        "num_beds":"5",
        "num_units":"1",
        "property_type":"house",
        "year_built":"2007",
        "available_dates_price_config" : [
          {
              "start_date":"2020-11-15",
              "end_date":"2020-12-15",
              "rate":"10000",
              "currency":"USD",
              "interval":"nightly",
          },
          {
              "start_date":"2020-11-15",
              "end_date":"2020-12-15",
              "rate":"50000",
              "currency":"USD",
              "interval":"weekly",
          },
        ],
        "applink" : {
          "ios_url":"example-ios://travelapp",
          "ios_app_store_id":"42",
          "ios_app_name":"Travel App iOS",
          "android_url":"example-android://travelapp",
          "android_package":"com.travelapp",
          "android_class":"com.travelapp.Example",
          "android_app_name":"Travel App Android",
        },
        "url":"http://www.example.com/link_to_listing"
      }
    },
    {
      "method": "UPDATE",
      "data": {
        "price": "100000 USD",
        "home_listing_id": "home-listing-3",
      }
    }
  ]
}

응답 샘플 - HOME_LISTING

{
  // One or more handles will be returned"handles": ["AczwaOW7j_EuQ5peV3kGq8X9qc7cDiv_kFrrHkdKuG7LkpkkqK5939wgdoduSQ45FGK5vKdVqOaSDJEun-fvbsR1kk8Rd53AZyD1WThSemo26Q"]
}

VEHICLE

VEHICLE 유형의 CREATEUPDATE에 대해 지원되는 필드는 자동차 인벤토리 카탈로그 필드 - 차량을 참조하세요.

지원되는 필드는 차량대리점에 제공됩니다.

UPDATE 메서드는 품목이 존재하지 않는 경우 품목을 만드는 데 사용할 수도 있습니다.

요청 샘플 - VEHICLE

curl \
  -d @body.json \
  -H "Content-Type: application/json"

  {
    "access_token": "<ACCESS_TOKEN>",
    "item_type": "VEHICLE",
    "requests": [
      {
        "method": "DELETE",
        "data": {
          "vehicle_id": "vehicle-1"
        }
      },
      {
        "method": "CREATE",
        "data": {
          "vehicle_id": "i2 2017 Ford Fusion",
          "availability": "AVAILABLE",
          "make": "Ford",
          "model": "Fusion",
          "year": "2017",
          "mileage": {
            "value": "1500",
            "unit": "KM",
          },
          "image": [
            {
                "url":"http://www.facebook.com/teapic.jpg",
                "tag":["Car"],
            },
          ],
          "fuel_type":"gasoline",
          "body_style":"sedan",
          "drivetrain":"FWD",
          "vin":"1FADP5AU6DL536022",
          "condition":"EXCELLENT",
          "description": "Turbocharged! Gasoline!",
          "title": "SE Ford Certified and 6-Speed Automatic.",
          "price": "18000 USD",
          "exterior_color":"white",
          "sale_price":"16000 USD",
          "state_of_vehicle":"new",
          "longitude":"52.35",
          "latitude":"42.1",
          "address": {
              "addr1":"550 Auto Center Dr",
              "city":"Watsonville",
              "region":"CA",
              "country":"US",
              "postal_code":"96075"
          },
          "url":"http://www.example.com/test"
        }
      },
      {
        "method": "UPDATE",
        "data": {
          "price": "16000 USD",
          "vehicle_id": "vehicle-3",
        }
      }
    ]
  }

응답 샘플 - VEHICLE

{
  // One or more handles will be returned"handles": ["AczwaOW7j_EuQ5peV3kGq8X9qc7cDiv_kFrrHkdKuG7LkpkkqK5939wgdoduSQ45FGK5vKdVqOaSDJEun-fvbsR1kk8Rd53AZyD1WThSemo26Q"]
}

지원되는 필드 - 현지화된 품목 배치 전송 - /{catalog_id}/localized_items_batch

/{catalog_id}/localized_items_batch 엔드포인트에 지원되는 필드 리스트와 각 필드에 대한 설명을 참조하세요.

카탈로그에서 지원되는 필드전체 리스트를 참조하세요.

더 알아보기