Meta Business SDK 新手指南

本文件講解安裝 Meta Business SDK 和測試安裝成果的方法。SDK 適用於 Java、JavaScript、PHP、Python 和 Ruby。如果您已經安裝推廣 API，可以了解如何將其更新為 Meta Business SDK。

準備工作

您需要擁有以下項目的存取權：

Meta 開發人員帳戶
已註冊且配置好基本設定的 Meta 應用程式
您的應用程式密鑰
廣告帳戶
專頁存取憑證

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

在終端機視窗中，從專案資料夾運行以下指令，以安裝適用於 Ruby 的 Meta Business SDK。視乎您的開發環境，您可能需要設定 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

Node.js

在 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 檔案中如下操作：

將 facebook-ads-sdk 更新為 8.0.3 版本的 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 的原始程式碼。