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 应用，以 Node.js 包的形式分发 Meta Business SDK。

打开命令终端窗口，新建一个项目文件夹。使用以下命令创建、配置和安装您的项目：

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}"
        }
    ]
}

在终端窗口中运行以下命令，以便安装 Meta Business 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 应用，我们以 pypi 模块的形式分发 Meta Business SDK，所以请务必确保您已安装 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，以 RubyGem 包的形式分发 SDK。

安装 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

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 文件中：

• 将 facebook-ads-sdk 更新为 facebook-business-sdk（8.0.3 版本）

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 的源代码。