API Marketing

Mẫu tìm kiếm khách hàng tiềm năng cho quảng cáo

Tài liệu này mô tả cách sử dụng API Marketing để có thể tạo quảng cáo tìm kiếm khách hàng tiềm năng bằng API Đồ thị.

Nếu muốn tạo và đăng quảng cáo tìm kiếm khách hàng tiềm năng, bạn sẽ làm theo các bước dưới đây:

  1. Tạo chiến dịch quảng cáo
  2. Tạo nhóm quảng cáo để liên kết quảng cáo với chiến dịch quảng cáo
  3. Tạo mẫu tìm kiếm khách hàng tiềm năng
  4. Tạo nội dung quảng cáo bằng mẫu tìm kiếm khách hàng tiềm năng
  5. Liên kết chiến dịch và nội dung để tạo quảng cáo
  6. Đăng quảng cáo

Trước khi bạn bắt đầu

Hướng dẫn này giả định rằng bạn đã đọc phần Tổng quan về nền tảng Messenger, cũng như triển khai các thành phần cần thiết để gửi/nhận tin nhắn và thông báo.

Bạn sẽ cần có:

Bước 1. Tạo chiến dịch

Để tạo chiến dịch quảng cáo cho quảng cáo tìm kiếm khách hàng tiềm năng, hãy gửi yêu cầu POST đến điểm cuối /act_AD_ACCOUNT_ID/campaigns với các thông số sau:

  • access_token được đặt là mã truy cập Trang của bạn
  • buying_type được đặt là AUCTION
  • name được đặt là tên chiến dịch của bạn
  • objective được đặt là LEAD_GENERATION
  • special_ad_categories được đặt là NONE hoặc danh mục quảng cáo đặc biệt của bạn
  • status được đặt là PAUSED

Yêu cầu mẫu

Được định dạng để dễ đọc. Thay thế các giá trị in đậm, in nghiêng như AD_ACCOUNT_ID bằng các giá trị của bạn.
curl -X POST "https://graph.facebook.com/v19.0/act_AD_ACCOUNT_ID/campaigns" \
     -H "Content-Type: application/json" \
     -d '{
           "access_token":"Your_page_access_token",
           "buying_type":"AUCTION",
           "name":"Messenger_ad_campaign_name",
           "objective":"LEAD_GENERATION",
           "special_ad_categories":["NONE"],
           "status":"PAUSED"
         }'

Khi thành công, ứng dụng của bạn sẽ nhận được một đối tượng JSON chứa ID của chiến dịch. ID này sẽ được dùng khi tạo nhóm quảng cáo ở bước tiếp theo.

{
  "id": "YOUR_CAMPAIGN_ID"
}

Truy cập vào tài liệu tham khảo về Chiến dịch quảng cáo để tìm hiểu thêm.

Bước 2. Tạo nhóm quảng cáo

Để tạo nhóm quảng cáo, hãy gửi yêu cầu POST đến điểm cuối act_ad_account_id/adsets, trong đó ad_account_id là ID tài khoản quảng cáo của bạn trên Meta. Yêu cầu của bạn phải bao gồm:

  • access_token được đặt là mã truy cập Trang của bạn
  • bid_amount được đặt là số tiền tối đa bạn muốn chi trả
  • billing_event được đặt là IMPRESSIONS
  • campaign_id được đặt là ID chiến dịch quảng cáo của bạn ở Bước 1
  • daily_budget được đặt là số tiền bạn muốn chi tiêu mỗi ngày
  • name được đặt là tên nhóm quảng cáo của bạn
  • optimization_goal được đặt là LEAD_GENERATION hoặc QUALITY_LEAD
  • promoted_object - được đặt là ID Trang Facebook của doanh nghiệp bạn
  • status được đặt là PAUSED

Lưu ý: Nếu đã thiết lập nguồn dữ liệu CRM và chọn QUALITY_LEAD làm mục tiêu tối ưu hóa, bạn có thể thêm pixel_id vào promoted_object để tối ưu hóa chất lượng hơn nữa. Lưu ý rằng bạn không cần cung cấp pixel_rule kèm theo pixel_id.

Yêu cầu mẫu

Được định dạng để dễ đọc. Thay thế các giá trị in đậm, in nghiêng như AD_ACCOUNT_ID bằng các giá trị của bạn.
curl -X POST "https://graph.facebook.com/v19.0/act_AD_ACCOUNT_ID/adsets"
     -H "Content-Type: application/json" 
     -d '{
           "access_token":"Your_page_access_token",
           "bid_amount":"Your_bid_amount",
           "billing_event":"IMPRESSIONS",
           "campaign_id":"Your_campaign_id",
           "daily_budget":"Your_daily_budget",
           "name:"YOUR_LEADADS_ADSET",
           "optimization_goal:LEAD_GENERATION",
           "promoted_object":"YOUR_PAGE_ID",
           "status:PAUSED"
         }'

Khi thành công, ứng dụng của bạn sẽ nhận được phản hồi JSON dưới đây chứa ID nhóm quảng cáo.

{
  "id": "YOUR_ADSET_ID"
}

Truy cập vào tài liệu tham khảo về Nhóm quảng cáo để tìm hiểu thêm.

Bước 3. Tạo mẫu tìm kiếm khách hàng tiềm năng

Để tạo một mẫu, hãy gửi yêu cầu POST đến điểm cuối /PAGE_ID/leadgen_forms với các thông số sau:

  • access_token được đặt là mã truy cập Trang của bạn
  • name được đặt thành tên mẫu của bạn
  • questions được đặt thành mảng đối tượng xác định loại câu hỏi và thứ tự mà câu hỏi sẽ xuất hiện trong mẫu với thông số key
    • một câu hỏi tùy chỉnh sử dụng thông số label
    • một câu hỏi tùy chỉnh sử dụng thông số options với menu câu trả lời thả xuống

Yêu cầu mẫu

Được định dạng để dễ đọc. Thay thế các giá trị in đậm, in nghiêng bằng các giá trị của bạn.
curl -X POST "https://graph.facebook.com/v19.0/PAGE_ID/leadgen_forms" \
     -H "Content-Type: application/json" \
     -d '{
           "access_token": "YOUR_PAGE_ACCESS_TOKEN",
           "name": "YOUR_LEADADS_FORM_NAME",
           "questions": "[
               {"type":"FULL_NAME", "key": "question1"},
               {"type":"EMAIL", "key": "question2"},
               {"type":"PHONE", "key": "question3"},
               {"type":"CUSTOM", "key": "question4" "label": "Do you like rainbows?"}
               {"type":"CUSTOM", "key": "question5" "label": "What is your favorite color?", 
                   "options": [
                       {value: "Red", key: "key1"},
                       {value: "Green", key: "key2"},
                       {value: "Blue", key: "key2"},
                   ]}
           ]"
         }'

Mẫu cho cuộc trò chuyện trên Messenger

Mẫu mà bạn muốn sử dụng cho quảng cáo trong cuộc trò chuyện trên Messenger phải chứa các thông số sau đây:

  • Bạn chỉ có thể đặt thông số questions.type là một trong những giá trị dưới đây:
    • CUSTOM
    • EMAIL
    • FIRST_NAME
    • FULL_NAME
    • LAST_NAME
    • PHONE

    Mẫu sẽ không đủ điều kiện nếu có questions.type được đặt là bất kỳ giá trị nào khác với những giá trị nêu trên.

  • Thông số block_display_for_non_targeted_viewer phải được đặt là false. Giá trị này đánh dấu mẫu là Chia sẻ công khai.

Ví dụ về yêu cầu cho mẫu tìm kiếm khách hàng tiềm năng đủ điều kiện trên Messenger

Được định dạng để dễ đọc. Thay thế các giá trị in đậm, in nghiêng bằng các giá trị của bạn.
curl -X POST "https://graph.facebook.com/v19.0/PAGE_ID/leadgen_forms" \
     -H "Content-Type: application/json" \
     -d '{
           "access_token": "page_ACCESS_TOKEN"
           "block_display_for_non_targeted_viewer": "false"
           "name": "LeadAds Form for Messenger Conversation Name"
           "questions": "[
               {"type":"FULL_NAME", "key": "question1"},
               {"type":"EMAIL", "key": "question2"},
               {"type":"PHONE", "key": "question3"},
               {"type":"CUSTOM", "key": "question4" "label": "Do you like rainbows?"}
               {"type":"CUSTOM", "key": "question5" "label": "What is your favorite color?", 
                   "options": [
                       {value: "Red", key: "key1"},
                       {value: "Green", key: "key2"},
                       {value: "Blue", key: "key2"},
                   ]}
           ]"
         }'

Loại câu hỏi khác

Ngoài các loại câu hỏi điển hình hiển thị trong [phần Tạo mẫu tìm kiếm khách hàng tiềm năng]{#create-a-lead-form}, bạn có thể thêm các loại câu hỏi chuyên biệt hơn cho những mục đích sử dụng dưới đây:

  • Lên lịch hẹn - Câu hỏi lên lịch hẹn sẽ hiển thị bộ chọn ngày và giờ với lựa chọn giờ giới hạn cũng như thông báo xác nhận bên dưới câu hỏi.
  • Căn cước công dân hoặc giấy tờ tùy thân do chính phủ cấp - Câu hỏi về căn cước công dân sẽ hiển thị câu hỏi dựa trên quốc gia của người dùng và xác thực định dạng của căn cước công dân đã nhập.
  • Công cụ tìm vị trí cửa hàng - Câu hỏi về công cụ tìm vị trí cửa hàng sẽ hiển thị bộ chọn công cụ tìm vị trí cửa hàng dựa trên thông tin về mã zip hoặc mã bưu chính do người dùng cung cấp.

Lên lịch hẹn

Câu hỏi lên lịch hẹn sẽ hiển thị bộ chọn ngày và giờ với lựa chọn giờ giới hạn cũng như thông báo xác nhận bên dưới câu hỏi.

Để thêm câu hỏi lên lịch hẹn, hãy thêm một đối tượng câu hỏi và đặt thông số type là DATE_TIME. Bạn cũng có thể thêm thông báo xác nhận trong thông số inline_context nếu muốn. Thông số này sẽ hiển thị ngay bên dưới trường câu hỏi để cung cấp thêm ngữ cảnh, nếu cần.

...
           "questions": "[
               ...
               {"type": "DATE_TIME", 
                "label": "Appointment time", 
                "inline_context": "We will verify and call you to confirm your appointment."
               },
...

Căn cước công dân

Câu hỏi về căn cước công dân hiển thị câu hỏi dựa trên quốc gia của người dùng và xác thực định dạng của căn cước công dân đã nhập. Hệ thống có thể hiển thị câu hỏi này cho các quốc gia sau:

  • Argentina - {"type": "ID_AR_DNI"}
  • Brazil - ID_CPF
  • Chile - ID_CL_RUT
  • Colombia - ID_CO_CC
  • Ecuador - ID_EC_CI
  • Peru - ID_PE_DNI

Để thêm câu hỏi về căn cước công dân, hãy thêm đối tượng câu hỏi và đặt thông số type thành loại quốc gia của người dùng.

Giới hạn

  • Bạn chỉ có thể yêu cầu một Căn cước công dân duy nhất trong mẫu cho trước bất kỳ và chỉ có thể nhắm đến người dùng ở quốc gia tương ứng của họ. Ví dụ: nếu bạn yêu cầu DNI từ Peru, đối tượng mục tiêu của bạn phải được giới hạn ở Peru. Chỉ những quảng cáo khớp với tiêu chí này mới được phê duyệt.
  • Hoạt động xác thực sẽ kiểm tra xem định dạng có hợp lệ hay không, chứ không xác minh rằng căn cước công dân thực sự thuộc về một người thật.
...
           "questions": "[
               ...
               {"type": "ID_AR_DNI"
               },
...

Công cụ tìm vị trí cửa hàng

Câu hỏi về công cụ tìm vị trí cửa hàng sẽ hiển thị bộ chọn công cụ tìm vị trí cửa hàng dựa trên thông tin về mã zip hoặc mã bưu chính do người dùng cung cấp.

Bạn sẽ cần thiết lập Cấu trúc trang cửa hàng để sử dụng câu hỏi này. Hãy tìm hiểu cách thực hiện trong Thiết lập cấu trúc trang cửa hàng trên Facebook - Trung tâm trợ giúp doanh nghiệp của Meta

Để thêm câu hỏi về công cụ tìm vị trí cửa hàng, hãy thêm đối tượng câu hỏi và đặt thông số type là STORE_LOOKUP, thông số context_provider_type là LOCATION_MANAGER.

...
           "questions": "[
               ...
               {"type": "STORE_LOOKUP", 
                "label": "Which store do you want to visit?", 
                "context_provider_type": "LOCATION_MANAGER"
               },
...

Cài đặt mẫu nâng cao

Thêm một hoặc nhiều chế độ cài đặt mẫu dưới đây để tìm kiếm khách hàng tiềm năng có chất lượng cao hơn:

Thêm chế độ cài đặt theo dõi thiệu quả

Để giúp bạn theo dõi nguồn khách hàng tiềm năng, hãy thêm vào mẫu của mình trường tracking_parameters rồi đặt là danh sách cặp khóa-giá trị của những thông số mà bạn muốn theo dõi. Các thông số này không xuất hiện trong quảng cáo của bạn, nhưng sẽ cho phép Meta cung cấp cho bạn siêu dữ liệu về khách hàng tiềm năng tìm được qua mẫu.

Yêu cầu mẫu

Được định dạng để dễ đọc. Thay thế các giá trị in đậm, in nghiêng bằng các giá trị của bạn.
...
           "name": "YOUR_LEADADS_FORM_NAME",
           "tracking_parameters": {"your_tracking_parameter_name":"your_tracking_parameter_value"},
           "questions": "[
...

Thêm chế độ cài đặt ý định rõ ràng hơn

Theo mặc định, quảng cáo tìm kiếm khách hàng tiềm năng được tối ưu hóa cho số lượng khách hàng tiềm năng. Tuy nhiên, bạn có thể tạo mẫu để thu hút khách hàng tiềm năng có ý định rõ ràng hơn. Kiểu khách hàng tiềm năng như vậy có thể là những người quan tâm đến một sản phẩm hoặc dịch vụ cụ thể, chẳng hạn như đăng ký lái thử tại đại lý. Chế độ cài đặt mẫu này thêm một bước vào quy trình gửi mẫu để người dùng xem lại và xác nhận câu trả lời của họ trước khi gửi mẫu.

Để thêm quy trình xác nhận này vào mẫu của bạn, hãy thêm thông số is_optimized_for_quality và đặt thông số này là true khi tạo mẫu.

Yêu cầu mẫu

Được định dạng để dễ đọc. Thay thế các giá trị in đậm, in nghiêng bằng các giá trị của bạn.
...
           "name": "YOUR_LEADADS_FORM_NAME",
           "is_optimized_for_quality": "true",
           "questions": "[
...

Lọc ra khách hàng tiềm năng tự nhiên

Để lọc ra khách hàng tiềm năng tự nhiên, hãy thêm thông số block_display_for_non_targeted_viewer và đặt thông số này là true khi bạn tạo mẫu.

Yêu cầu mẫu

Được định dạng để dễ đọc. Thay thế các giá trị in đậm, in nghiêng bằng các giá trị của bạn.
...
           "name": "YOUR_LEADADS_FORM_NAME",
           "block_display_for_non_targeted_viewer": "true",
           "questions": "[
...

Phản hồi mẫu

Khi thành công, ứng dụng của bạn sẽ nhận được phản hồi JSON chứa ID của mẫu sẽ được dùng khi tạo quảng cáo.

{
  "id": "leadgen_form_id",
}

Bước 4. Tạo nội dung quảng cáo

Để tạo nội dung quảng cáo có hình ảnh và mẫu của bạn, hãy gửi yêu cầu POST đến điểm cuối /act_AD_ACCOUNT_ID/adcreatives với các thông số sau:

  • access_token được đặt là mã truy cập Trang của bạn
  • object_story_spec chứa đối tượng link_data có các thông số sau:
    • call_to_action được đặt là đối tượng chứa type và value được đặt là ID mẫu tìm kiếm khách hàng tiềm năng của bạn
    • description được đặt là phần mô tả cho nội dung của bạn
    • image_hash được đặt là hash của hình ảnh cho nội dung quảng cáo của bạn
    • link_url được đặt là URL của bạn. Không được là Trang Facebook của bạn
    • message được đặt là văn bản cho nội dung quảng cáo của bạn
  • page_id được đặt là ID Trang Facebook của bạn

Lưu ý: Trong khi tạo link_data, giá trị được liên kết với trường link chỉ có thể là https//fb.me/.

Thông số link_data.call_to_action phải được đặt là một trong những giá trị dưới đây:

  • APPLY_NOW
  • DOWNLOAD
  • GET_QUOTE
  • LEARN_MORE
  • SIGN_UP
  • SUBSCRIBE

Yêu cầu mẫu

Được định dạng để dễ đọc. Thay thế các giá trị in đậm, in nghiêng như AD_ACCOUNT_ID bằng các giá trị của bạn.
curl -X POST "https://graph.facebook.com/LATEST-API-VERSION/act_AD_ACCOUNT_ID/adcreatives" \
     -H "Content-Type: application/json" \
     -d '{
           "access_token":"YOUR_PAGE_ACCESS_TOKEN",
           "object_story_spec":{ 
             "link_data": { 
               "call_to_action": {
                 "type":"SIGN_UP",
                 "value":{
                   "lead_gen_form_id":"YOUR_FORM_ID"
                 }
               }, 
               "description": "YOUR_AD_CREATIVE_DESCRIPTION", 
               "image_hash": "YOUR_IMAGE_HASH", 
               "link": "http:\/\/fb.me\/", 
               "message": "YOUR_AD_CREATIVE_MESSAGE" 
             }, 
           "page_id": "YOUR_PAGE_ID" 
         }'

Bạn có thể tạo một quảng cáo tìm kiếm khách hàng tiềm năng quay vòng bằng cùng object_story_spec, nhưng có thêm trường lead_gen_form_id được xác định trong thông số child_attachments.

Bạn chỉ có thể chỉ định cùng <FORM_ID> cho tất cả các file đính kèm con.

curl \
  -F 'object_story_spec={ 
    "page_id": "<PAGE_ID>", 
    "link_data": { 
      "message": "My description", 
      "link": "http:\/\/www.google.com", 
      "caption": "WWW.EXAMPLE.COM", 
      "child_attachments": [ 
        { 
          "link": "http:\/\/www.google.com", 
          "image_hash": "<IMAGE_HASH>", 
          "call_to_action": {"type":"SIGN_UP","value":{"lead_gen_form_id":"<FORM_ID>"}} 
        }, 
        { 
          "link": "http:\/\/www.google.com", 
          "image_hash": "<IMAGE_HASH>", 
          "call_to_action": {"type":"SIGN_UP","value":{"lead_gen_form_id":"<FORM_ID>"}} 
        }, 
        { 
          "link": "http:\/\/www.google.com", 
          "image_hash": "<IMAGE_HASH>", 
          "call_to_action": {"type":"SIGN_UP","value":{"lead_gen_form_id":"<FORM_ID>"}} 
        }, 
        { 
          "link": "http:\/\/www.google.com", 
          "image_hash": "<IMAGE_HASH>", 
          "call_to_action": {"type":"SIGN_UP","value":{"lead_gen_form_id":"<FORM_ID>"}} 
        } 
      ], 
      "multi_share_optimized": true, 
      "call_to_action": {"type":"SIGN_UP","value":{"lead_gen_form_id":"<FORM_ID>"}} 
    } 
  }' \
  -F 'access_token=<ACCESS_TOKEN>' \
  https://graph.facebook.com/LATEST-API-VERSION/act_<AD_ACCOUNT_ID>/adcreatives

Có video

Bạn cũng có thể sử dụng video thay vì ảnh trong nội dung quảng cáo tìm kiếm khách hàng tiềm năng. Trước tiên, hãy tải video lên thư viện video quảng cáo rồi sử dụng video đó trong thông số object_story_spec:

curl -X POST \
  -F 'object_story_spec={
       "page_id": "<PAGE_ID>",
       "video_data": {
         "link_description": "try it out",
         "image_url": "<IMAGE_URL>",
         "video_id": "<VIDEO_ID>",
         "call_to_action": {
           "type": "SIGN_UP",
           "value": {
             "link": "http://fb.me/",
             "lead_gen_form_id": "<FORM_ID>"
           }
         }
       }
     }' \
  -F 'access_token=<ACCESS_TOKEN>' \
  https://graph.facebook.com/v19.0/act_<AD_ACCOUNT_ID>/adcreatives

Phản hồi mẫu về nội dung quảng cáo

Khi thành công, ứng dụng của bạn sẽ nhận được phản hồi JSON dưới đây chứa ID nội dung quảng cáo.

{
  "id": "YOUR_AD_CREATIVE_ID"
}

Nếu muốn tạo quảng cáo, bạn cần liên kết nội dung quảng cáo và nhóm quảng cáo. Để tạo quảng cáo, hãy gửi yêu cầu POST đến điểm cuối /act_AD_ACCOUNT_ID/ads. Yêu cầu của bạn phải bao gồm:

  • access_token được đặt là mã truy cập Trang của bạn
  • adset_id (ở Bước 2)
  • creative_id (ở Bước 4)
  • tên
  • trạng thái

Yêu cầu mẫu về quảng cáo có nội dung

Được định dạng để dễ đọc. Thay thế các giá trị in đậm, in nghiêng như AD_ACCOUNT_ID bằng các giá trị của bạn.
curl -X POST "https://graph.facebook.com/v19.0/act_AD_ACCOUNT_ID/ads"
     -H "Content-Type: application/json" 
     -d '{
           "access_token"="YOUR_PAGE_ACCESS_TOKEN",
           "adset_id"="YOUR_AD_SET_ID",
           "creative"={ "creative_id": "YOUR_AD_CREATIVE_ID" },
           "status"="PAUSED"
         }'

Khi thành công, ứng dụng của bạn sẽ nhận được phản hồi JSON dưới đây chứa ID quảng cáo.

{
  "id": "YOUR_AD_ID"
}

Bước 6. Đăng quảng cáo

Xác minh để đảm bảo rằng quảng cáo của bạn có trong trình quản lý quảng cáo . Nhấp vào nút Xem lại và đăng ở góc trên bên phải. Chọn chiến dịch của bạn, nhóm quảng cáo cho chiến dịch này rồi chọn quảng cáo.

Bạn có thể đăng quảng cáo từ trình quản lý quảng cáo hoặc thông qua API. Nếu bạn muốn đăng bằng API, hãy lặp lại Bước 4 với thông số status được đặt là ACTIVE.

Meta sẽ xét duyệt quảng cáo của bạn và trạng thái sẽ là PENDING_REVIEW. Sau khi được phê duyệt, trạng thái sẽ là ACTIVE và hệ thống sẽ phân phối quảng cáo của bạn.

Quản lý mẫu

Lấy danh sách mẫu, câu hỏi cụ thể về mẫu và lưu trữ mẫu cũ.

Lấy danh sách mẫu

Để lấy danh sách mẫu tìm kiếm khách hàng tiềm năng, hãy gửi yêu cầu GET đến điểm cuối /page_id/leadgen_forms với các thông số sau:

  • access_token được đặt là mã truy cập Trang của bạn
  • fields (không bắt buộc) được đặt thành danh sách các trường được phân tách bằng dấu phẩy để lấy thông tin cụ thể, chẳng hạn như tên và ID mẫu

Yêu cầu mẫu

Được định dạng để dễ đọc. Thay thế các giá trị in đậm, in nghiêng bằng các giá trị của bạn.
curl -X GET "https://graph.facebook.com/v19.0/PAGE_ID/leadgen_forms
    ?fields=name,id
    &access_token": "YOUR_PAGE_ACCESS_TOKEN"

Khi thành công, ứng dụng của bạn sẽ nhận được phản hồi JSON chứa danh sách mẫu của bạn. Bạn có thể dùng ID mẫu để lấy câu hỏi cho mẫu đó hoặc lưu trữ mẫu.

Lấy danh sách các mẫu đủ điều kiện cho Messenger

Chỉ những mẫu chứa yêu cầu cụ thể mới đủ điều kiện được gửi trong cuộc trò chuyện trên Messenger.

Để lấy danh sách các mẫu tìm kiếm khách hàng tiềm năng đủ điều kiện, hãy gửi yêu cầu GET đến điểm cuối /page_id/leadgen_forms với các thông số sau:

  • access_token được đặt là mã truy cập Trang của bạn
  • fields được đặt thành is_eligible_for_in_thread_forms

Yêu cầu mẫu

Được định dạng để dễ đọc. Thay thế các giá trị in đậm, in nghiêng bằng các giá trị của bạn.
curl -X GET "https://graph.facebook.com/v19.0/PAGE_ID/leadgen_forms
    ?fields=is_eligible_for_in_thread_forms
    &access_token": "YOUR_PAGE_ACCESS_TOKEN"

Khi thành công, ứng dụng của bạn sẽ nhận được phản hồi JSON chứa danh sách ID của mẫu đủ điều kiện.

{
  "data": [
    {
      "id": "eligible_form_1_id"
    },
    {
      "id": "eligible_form_2_id"
    }
  ],
...
}

Lấy danh sách câu hỏi

Để lấy danh sách câu hỏi cho một mẫu tìm kiếm khách hàng tiềm năng cụ thể, hãy gửi yêu cầu GET đến điểm cuối /page_id/leadgen_form_id với các thông số sau:

  • access_token được đặt là mã truy cập Trang của bạn
  • fields được đặt thành questions

Yêu cầu mẫu

Được định dạng để dễ đọc. Thay thế các giá trị in đậm, in nghiêng bằng các giá trị của bạn.
curl -X GET "https://graph.facebook.com/v19.0/page_id/leadgen_form_id
    ?fields=questions
    &access_token=page_access_token"

Khi thành công, ứng dụng của bạn sẽ nhận được phản hồi JSON chứa danh sách câu hỏi.

Lưu trữ mẫu

Bạn chỉ có thể lưu trữ mẫu tìm kiếm khách hàng tiềm năng vì tính năng xóa không được hỗ trợ. Sau khi một mẫu được lưu trữ:

  • Mẫu đó sẽ không xuất hiện (theo mặc định) trong Thư viện mẫu
  • Bạn không thể sử dụng một mẫu đã lưu trữ trong quảng cáo. Nếu bạn cố làm vậy, API này có thể trả về lỗi.
  • Các mẫu đã lưu trữ sẽ không sử dụng được trong quy trình tạo quảng cáo cho CF hoặc PE.

Để lưu trữ một mẫu tìm kiếm khách hàng tiềm năng cụ thể, hãy gửi yêu cầu POST đến điểm cuối /page_id/leadgen_form_id với các thông số sau:

  • access_token được đặt là mã truy cập Trang của bạn
  • status được đặt thành ARCHIVED

Yêu cầu mẫu

Được định dạng để dễ đọc. Thay thế các giá trị in đậm, in nghiêng bằng các giá trị của bạn.
curl -X GET "https://graph.facebook.com/v19.0/page_id/leadgen_form_id
    ?status=ARCHIVED
    &access_token=page_access_token"

Khi thành công, ứng dụng của bạn sẽ nhận được phản hồi JSON chứa một đối tượng với success được đặt thành true.

Bạn có thể kích hoạt lại một mẫu đã lưu trữ bằng cách gửi yêu cầu và đặt status là ACTIVE.

Thêm mẫu vào trang web

Nếu muốn thêm mẫu vào trang web của mình, bạn có thể sử dụng Facebook JavaScript SDK để khởi chạy một hộp thoại bật lên. Hộp thoại bật lên này khởi chạy ngay khi thực thi, vì vậy, hãy đảm bảo liên kết hộp thoại với một sự kiện thích hợp. Bạn sẽ có thể xác định lệnh gọi lại cung cấp dữ liệu cần thiết cho Nội dung quảng cáo. Meta lưu trữ mẫu ở cấp độ Trang.

Giới hạn

  • Hộp thoại này không được hỗ trợ trên thiết bị di động.

Lưu ý rằng act_không có trong giá trị ad_account_id.

SDK mẫu

Thay thế các giá trị in đậm, in nghiêng bằng các giá trị của bạn.

FB.ui({
  method: 'lead_gen',
  page_id: YOUR_PAGE_ID,
  ad_account_id: AD_ACCOUNT_ID, 
}, function(response) {
...
});

Phản hồi lệnh gọi lại mà bạn nhận được sẽ bao gồm thông tin về mẫu.

{
  follow_up_action_text: "YOUR_FOLLOW_UP_ACTION_TEXT",
  follow_up_action_url: "YOUR_FOLLOW_UP_ACTION_URL",
  formID: YOUR_FORM_ID,
  form_url: "YOUR_FORM_URL",
  is_tcpa_compliant: false,
  name: "YOUR_FORM_NAME",
  pageID: YOUR_PAGE_ID,
  privacy_policy_url: "YOUR_PRIVACY_POLICY_URL",
  status: "success"
}

Thuộc tính phản hồi

TênMô tả

custom_disclaimer_responseschuỗi

Phản hồi cho hộp kiểm tuyên bố từ chối trách nhiệm tùy chỉnh

follow_up_action_textchuỗi

Chú thích về nội dung hành động tiếp theo trên màn hình cuối cùng của mẫu

follow_up_action_urlchuỗi

Trang đích của nội dung hành động tiếp theo trên màn hình cuối cùng của mẫu

formIDchuỗi

Bắt buộc. ID của mẫu

form_urlchuỗi

URL đến mẫu

namechuỗi

Tên của mẫu

pageIDchuỗi

ID của trang chứa mẫu này

privacy_policy_urlchuỗi

URL chính sách quyền riêng tư được cung cấp

statuschuỗi

Trả về success khi mẫu được tạo xong

Nếu hủy quá trình tạo, bạn sẽ thấy thông báo sau:

{
  error_code: 4201,
  error_message: "User canceled the Dialog flow"
}

Xem thêm

Hãy truy cập vào những hướng dẫn khác của chúng tôi để tìm hiểu thêm về các thành phần trong tài liệu này.

Tài liệu về API Marketing dành cho nhà phát triển

Trung tâm trợ giúp doanh nghiệp của Meta