بدء استخدام مجموعة SDK من Meta للأعمال

يشرح هذا المستند كيفية تثبيت مجموعة SDK من Meta للأعمال واختبار التثبيت. تتوفر مجموعات SDK لـ Java وJavaScript وPHP وPython وRuby. إذا كنت قد قمت بتثبيت API التسويق بالفعل، فتعرف على كيفية التحديث إلى مجموعة SDK من Meta للأعمال.

قبل البدء

ستحتاج إلى الوصول إلى ما يلي:

Java

بالنسبة إلى تطبيقات Java، يمكنك استخدام بيئة التطوير التي تريد لكن يجب أن تدعم إصدارات Maven.

تثبيت مجموعة SDK

في مشروع Maven، أضف رمز XML التالي إلى القسم dependency من الملف 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>

إنشاء فئة Java

ضمن src/main/java، أنشئ فئة Java تُسمى TestFBJavaSDK وأضف الرمز التالي. تأكد من استبدال {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، استخدم أداة الإنشاء لتثبيت مجموعة 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

في نافذة الوحدة الطرفية، قم بتشغيل الأمر التالي من مجلد المشروع لتثبيت مجموعة SDK من Meta للأعمال في 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 التسويق الحاليين

لتحديث مجموعة SDK من Meta للأعمال من خلال API التسويق، اتبع هذه الخطوات.

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