Meta Business SDK 新手指南

本文件說明如何安裝 Meta Business SDK 並測試安裝。SDK 支援 Java、JavaScript、PHP、Python 和 Ruby。如果您已安裝行銷 API，請瞭解如何更新為 Meta Business SDK。

準備工作

您需要存取下列項目：

Java

若是 Java 應用程式，您可以使用任何偏愛的開發環境，但必須支援 Maven 組建。

安裝 SDK

在 Maven 專案中，將以下 XML 程式碼加入 pom.xml 檔的 dependency 區塊：

<!-- 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>

建立 Java 類別

在 src/main/java 之下，建立名為 TestFBJavaSDK 的 Java 類別，並新增以下程式碼。請務必將 {access-token}、{appsecret} 和 {adaccount-id} 替換為您的值。

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();
        }
    }}

測試安裝

建置和執行應用程式。您應該會在主控台記錄視窗中看到結果。若顯示權杖已過期，請要求新的粉絲專頁存取權杖並重試。

JavaScript（Node.js）

若是 JavaScript 應用程式，SDK 會以 Node.js 套件進行發佈。

開啟指令終端機視窗並新建專案資料夾。使用以下指令建立、設定和安裝專案：

npm init

您稍後可以直接編輯 package.json 檔來更新配置設定。

安裝 SDK

使用以下指令安裝 SDK 套件：

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

修改專案檔案

開啟 index.js 檔並新增以下程式碼。將 {access-token} 和 {adaccount-id} 替換為您的值。

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);

測試安裝

使用以下指令測試安裝：

 node index.js

您應該會在終端機視窗中看到結果。若顯示權杖已過期，請要求新的粉絲專頁存取權杖並重試。

PHP

若是 PHP 應用程式，請使用 Composer 安裝 SDK。

安裝 SDK

在新專案資料夾中，建立包含以下內容的 composer.json。將 {project-name}、{Your Name} 和 {your@email.com} 替換為您的值。

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

在終端機視窗中執行以下指令來安裝 SDK：

composer install

建立專案檔案

建立包含以下內容的 src/test.php 檔。將 {app-id}、{access-token}、{appsecret} 和 {adaccount-id} 替換為您的值。

<?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;
}

測試安裝

使用以下指令測試安裝：

php src/test.php

您應該會在終端機視窗中看到結果。若顯示權杖已過期，請要求新的粉絲專頁存取權杖並重試。

Python

若是 Python 應用程式，SDK 會以 pypi 模組進行發佈，因此請確定已安裝 pip。視您的系統而定，您可能需要設定 virtualenv、pyenv 或 conda。

安裝 SDK

使用以下指令安裝 SDK。

pip install facebook_business

建立專案檔案

建立包含以下內容的 test.py 檔。將 {app-id}、{access-token}、{appsecret} 和 {adaccount-id} 替換為您的值。

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)

測試安裝

使用以下指令測試安裝：

python test.py

您應該會在終端機視窗中看到結果。若顯示權杖已過期，請要求新的粉絲專頁存取權杖並重試。

Ruby

若是 Ruby，SDK 會以 RubyGem 套件進行發佈。

安裝 SDK

在終端機視窗中，從專案資料夾執行以下指令來安裝 Meta Business SDK for Ruby。視您的環境而定，您可能需要設定 rbenv 或 rvm，或是在指令之前使用 sudo。

gem install facebookbusiness

建立專案檔案

建立包含以下內容的 test.rb 檔。將 {access-token}、{appsecret} 和 {adaccount-id} 替換為您的值。

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

測試安裝

使用以下指令測試安裝：

ruby test.rb

您應該會在終端機視窗中看到結果。若顯示權杖已過期，請要求新的粉絲專頁存取權杖並重試。

目前使用行銷 API 的用戶

若要從行銷 API 更新為 Meta Business SDK，請按照以下步驟操作。

Java

在 pom.xml 檔中：

將 groupId 從 com.facebook.ads.sdk 更新為 com.facebook.business.sdk
將 artifactId 從 facebook-java-ads-sdk 更新為 facebook-java-business-sdk
將 version 更新為 v8.0.3

Nodejs

在 package.json 檔中：

將 facebook-nodejs-ads-sdk 更新為 facebook-nodejs-business-sdk:v8.0.2
將 facebook-nodejs-ads-sdk 套件名稱的所有參照（例如 require('facebook-nodejs-ads-sdk')）更新為 facebook-nodejs-business-sdk
執行 npm install

PHP

在 composer.json 檔中：

使用第 8.0.3 版將 facebook-ads-sdk 更新為 facebook-business-sdk

Python

執行 pip install facebook_business
將 facebookads 命名空間的所有參照更新為 facebook_business
如果您有 .egg-info 檔，請將其從 facebookads-*.egg-info 更新為新安裝的 egg-info 檔，例如 facebook_business-*.egg-info

Ruby

執行 gem install facebookbusiness
將所有參照從 require('facebook_ads') 更新為 require('facebookbusiness')

瞭解詳情

在 Github 上查看 Meta Business SDK 的原始程式碼。