Meta Business SDK

Bắt đầu sử dụng Meta Business SDK

Tài liệu này giải thích cách cài đặt Meta Business SDK và thử nghiệm cài đặt. Các SDK có thể dùng cho Java, JavaScript, PHP, Python và Ruby. Nếu bạn đã cài đặt API Marketing, hãy tìm hiểu cách cập nhật lên Meta Business SDK.

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

Bạn sẽ cần có quyền truy cập vào các mục sau:

Java

Đối với các ứng dụng Java, bạn có thể sử dụng bất kỳ môi trường phát triển nào mình thích nhưng môi trường đó phải hỗ trợ bản dựng Maven.

Cài đặt SDK

Đối với dự án Maven, hãy thêm mã XML sau đây vào phần dependency của file pom.xml:

<!-- https://mvnrepository.com/artifact/com.facebook.business.sdk/facebook-java-business-sdk -->
<dependency>
    <groupId>com.facebook.business.sdk</groupId>
    <artifactId>facebook-java-business-sdk</artifactId> 
    <version>[8.0.3,)</version>
</dependency>

Tạo lớp Java

Trong src/main/java, hãy tạo một lớp Java có tên là TestFBJavaSDK rồi thêm mã sau đây. Hãy nhớ thay thế {access-token}, {appsecret} và {adaccount-id} bằng các giá trị của bạn.

import com.facebook.ads.sdk.APIContext;
import com.facebook.ads.sdk.APINodeList;
import com.facebook.ads.sdk.AdAccount;
import com.facebook.ads.sdk.Campaign;

public class TestFBJavaSDK
{
    public static final APIContext context = new APIContext(
            "{access-token}",
            "{appsecret}"
    );
    public static void main(String[] args)
    {
        AdAccount account = new AdAccount("act_{{adaccount-id}}", context);
        try {
            APINodeList<Campaign> campaigns = account.getCampaigns().requestAllFields().execute();
            for(Campaign campaign : campaigns) {
                System.out.println(campaign.getFieldName());
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }}

Thử nghiệm cài đặt

Xây dựng và chạy ứng dụng của bạn. Bạn sẽ nhìn thấy kết quả trong cửa số đăng nhập trên bảng điều khiển. Nếu thấy kết quả phàn nàn về mã hết hạn, hãy yêu cầu Mã truy cập Trang mới rồi thử lại.

JavaScript (Node.js)

Đối với các ứng dụng JavaScript, SDK này được phân phối dưới dạng gói Node.js.

Mở cửa sổ dòng lệnh và tạo một thư mục dự án mới. Sau đó tạo, đặt cấu hình và cài đặt dự án của bạn bằng lệnh dưới đây:

npm init

Bạn có thể cập nhật cài đặt cấu hình vào lúc khác bằng cách chỉnh sửa trực tiếp file package.json.

Cài đặt SDK

Cài đặt gói SDK bằng lệnh sau đây:

npm install --save facebook-nodejs-business-sdk

Sửa đổi file dự án

Mở file index.js và thêm mã sau đây. Thay thế {access-token} và {adaccount-id} bằng các giá trị của bạn.

const bizSdk = require('facebook-nodejs-business-sdk');

const accessToken = '{access-token}';
const accountId = 'act_{{adaccount-id}}';

const FacebookAdsApi = bizSdk.FacebookAdsApi.init(accessToken);
const AdAccount = bizSdk.AdAccount;
const Campaign = bizSdk.Campaign;

const account = new AdAccount(accountId);
var campaigns;
    
account.read([AdAccount.Fields.name])
  .then((account) =>{
    return account.getCampaigns([Campaign.Fields.name], { limit: 10 }) // fields array and params
  })
  .then((result) =>{
    campaigns = result
    campaigns.forEach((campaign) =>console.log(campaign.name))  
  }).catch(console.error);

Thử nghiệm cài đặt

Thử nghiệm cài đặt bằng lệnh sau đây:

 node index.js

Bạn sẽ nhìn thấy kết quả trong cửa số dòng lệnh. Nếu thấy kết quả phàn nàn về mã hết hạn, hãy yêu cầu Mã truy cập Trang mới rồi thử lại.

PHP

Đối với các ứng dụng PHP, hãy dùng Composer để cài đặt SDK này.

Cài đặt SDK

Trong thư mục dự án mới, hãy tạo composer.json với nội dung sau đây. Thay thế {project-name}, {Your Name} và {your@email.com} bằng các giá trị của bạn.

{
    "name": "name/{project-name}",
    "type": "project",
    "require": {
        "facebook/php-business-sdk": "^8.0.3"
    },
    "authors": [
        {
            "name": "{Your Name}",
            "email": "{your@email.com}"
        }
    ]
}

Cài đặt SDK bằng cách chạy lệnh sau đây trong cửa sổ dòng lệnh:

composer install

Tạo file dự án

Tạo file src/test.php với nội dung sau đây. Thay thế {app-id}, {access-token}, {appsecret} và {adaccount-id} bằng các giá trị của bạn.

<?php
require_once __DIR__ . '/../vendor/autoload.php';
use FacebookAds\Api;
use FacebookAds\Logger\CurlLogger;
use FacebookAds\Object\AdAccount;
use FacebookAds\Object\Campaign;
use FacebookAds\Object\Fields\CampaignFields;

$app_id = "{app-id}";
$app_secret = "{appsecret}";
$access_token = "{access-token}";
$account_id = "act_{{adaccount-id}}";

Api::init($app_id, $app_secret, $access_token);

$account = new AdAccount($account_id);
$cursor = $account->getCampaigns();

// Loop over objects
foreach ($cursor as $campaign) {
  echo $campaign->{CampaignFields::NAME}.PHP_EOL;
}

Thử nghiệm cài đặt

Thử nghiệm cài đặt bằng lệnh sau đây:

php src/test.php

Bạn sẽ nhìn thấy kết quả trong cửa số dòng lệnh. Nếu thấy kết quả phàn nàn về mã hết hạn, hãy yêu cầu Mã truy cập Trang mới rồi thử lại.

Python

Đối với các ứng dụng Python, SDK này được phân phối dưới dạng mô-đun pypi, vậy nên hãy nhớ cài đặt pip. Tùy thuộc vào hệ thống của bạn, có thể bạn sẽ cần thiết lập virtualenv, pyenv hoặc conda.

Cài đặt SDK

Cài đặt SDK bằng lệnh sau đây.

pip install facebook_business

Tạo file dự án

Tạo file test.py với nội dung sau đây. Thay thế {app-id}, {access-token}, {appsecret} và {adaccount-id} bằng các giá trị của bạn.

from facebook_business.api import FacebookAdsApi
from facebook_business.adobjects.adaccount import AdAccount

my_app_id = '{app-id}'
my_app_secret = '{appsecret}'
my_access_token = '{access-token}'
FacebookAdsApi.init(my_app_id, my_app_secret, my_access_token)
my_account = AdAccount('act_{{adaccount-id}}')
campaigns = my_account.get_campaigns()
print(campaigns)

Thử nghiệm cài đặt

Thử nghiệm cài đặt bằng lệnh sau đây:

python test.py

Bạn sẽ nhìn thấy kết quả trong cửa số dòng lệnh. Nếu thấy kết quả phàn nàn về mã hết hạn, hãy yêu cầu Mã truy cập Trang mới rồi thử lại.

Ruby

Đối với Ruby, SDK này được phân phối dưới dạng gói RubyGem.

Cài đặt SDK

Trong cửa sổ dòng lệnh, hãy chạy lệnh sau đây từ thư mục dự án của bạn để cài đặt Meta Business SDK dành cho Ruby. Tùy thuộc vào môi trường của bạn, có thể bạn sẽ cần thiết lập rbenv/rmv hoặc sử dụng sudo trước dòng lệnh này.

gem install facebookbusiness

Tạo file dự án

Tạo file test.rb với nội dung sau đây. Thay thế {access-token}, {appsecret} và {adaccount-id} bằng các giá trị của bạn.

require 'facebookbusiness'
FacebookAds.configure do |config|
  config.access_token = '{access-token}'
  config.app_secret = '{appsecret}'
end

ad_account = FacebookAds::AdAccount.get('act_{{adaccount-id}}', 'name')
ad_account.campaigns(fields: 'name').each do |campaign|
  puts campaign.name
end

Thử nghiệm cài đặt

Thử nghiệm cài đặt bằng lệnh sau đây:

ruby test.rb

Bạn sẽ nhìn thấy kết quả trong cửa số dòng lệnh. Nếu thấy kết quả phàn nàn về mã hết hạn, hãy yêu cầu Mã truy cập Trang mới rồi thử lại.

Đối với người dùng API Marketing hiện tại

Hãy thực thiện theo các bước dưới đây để cập nhật từ API Marketing lên Meta Business SDK.

Java

Trong file pom.xml:

  • Cập nhật groupId từ com.facebook.ads.sdk thành com.facebook.business.sdk
  • Cập nhật artifactId từ facebook-java-ads-sdk thành facebook-java-business-sdk
  • Cập nhật version thành v8.0.3

Nodejs

Trong file package.json:

  • Cập nhật facebook-nodejs-ads-sdk thành facebook-nodejs-business-sdk:v8.0.2
  • Cập nhật tất cả thông tin tham chiếu của tên gói facebook-nodejs-ads-sdk như require('facebook-nodejs-ads-sdk') thành facebook-nodejs-business-sdk
  • Chạy npm install

PHP

Trong file composer.json:

  • Cập nhật facebook-ads-sdk thành facebook-business-sdk với phiên bản 8.0.3

Python

  • Chạy pip install facebook_business
  • Cập nhật tất cả thông tin tham chiếu đến vùng tên facebookads thành facebook_business
  • Nếu bạn có file .egg-info, hãy cập nhật file này từ facebookads-*.egg-info thành file egg-info mới cài đặt như facebook_business-*.egg-info

Ruby

  • Chạy gem install facebookbusiness
  • Cập nhật tất cả thông tin tham chiếu từ require('facebook_ads') thành require('facebookbusiness')

Tìm hiểu thêm

Xem mã nguồn cho Meta Business SDK trên Github.