Memulai

Dokumen Referensi

Untuk menggunakan Pengelola Bisnis, suatu bisnis membutuhkan setidaknya satu halaman, admin, nama bisnis, dan alamat email yang valid.

Nama bisnis hanya digunakan untuk bisnis Anda dan bisnis lain yang Anda pilih untuk berbagi objek. Setelah Anda membuat bisnis ini, Anda dapat menambahkan halaman, akun iklan, aplikasi, objek pelacakan konversi di luar situs, dan aset terkait iklan lainnya yang dimiliki oleh bisnis.

Persyaratan

Membuat Pengelola Bisnis Baru

Buat pengelola bisnis baru untuk mewakili bisnis Anda. Buat pengelola bisnis baru hanya jika Anda sedang menyiapkan pengelola bisnis baru untuk diri sendiri atau klien Anda. Jika Anda memerlukan akun iklan lain atau akses ke halaman lain, Anda harus menggunakan izin pengelola dan aset yang ada. Anda tidak diizinkan menghapus pengelola bisnis.

Contohnya, buat Pengelola Bisnis baru dengan POST:

curl \
  -F "name=Pomni Media" \
  -F "vertical=ADVERTISING" \
  -F "primary_page=<PAGE_ID>" \
  -F "timezone_id=1" \
  -F "access_token=<ACCESS_TOKEN>" \
  "https://graph.facebook.com/<API_VERSION>/<USER_ID>/businesses"

Persyaratan

Untuk membuat bisnis, Anda memerlukan:

  • Token akses
  • ID Halaman
  • Vertikal
  • ID pengguna lingkup aplikasi

ID Halaman yang Anda sediakan harus merupakan halaman utama bisnis Anda. Halaman ini mewakili bisnis Anda secara publik di Facebook. Siapa pun yang membuat bisnis tersebut adalah pengelola halaman ini. Jika Anda tidak memiliki halaman untuk mewakili bisnis Anda di Facebook, buat halaman.

Vertikal adalah salah satu dari konstanta string ini:

ADVERTISING , AUTOMOTIVE , CONSUMER_PACKAGED_GOODS , ECOMMERCE , EDUCATION , ENERGY_AND_UTILITIES , ENTERTAINMENT_AND_MEDIA , FINANCIAL_SERVICES , GAMING , GOVERNMENT_AND_POLITICS ,MARKETING , ORGANIZATIONS_AND_ASSOCIATIONS , PROFESSIONAL_SERVICES , RETAIL , TECHNOLOGY , TELECOM , TRAVEL , OTHER

Untuk melihat properti untuk bisnis, gunakan ID-nya:

curl "https://graph.facebook.com/<API_VERSION>/<BUSINESS_ID>?access_token=<ACCESS_TOKEN>"

Anda juga dapat melihat daftar pengelola bisnis yang dapat Anda akses:

curl "https://graph.facebook.com/<API_VERSION>/me/businesses?access_token=<ACCESS_TOKEN>"

Kolom tanggapan mencakup:

Nama Deskripsi

name

jenis: string

Nama bisnis

timezone_id

jenis: int

ID zona waktu bisnis

primary_page

jenis: objek JSON

Objek halaman utama yang terkait dengan Pengelola Bisnis ini.

{ "category": "App page", "name": "Sample Primary Page", "id": "123456789" }

id

jenis: long

ID Pengelola Bisnis

update_time

jenis: string

Terakhir kali Pengelola Bisnis ini diperbarui

updated_by

jenis: objek JSON

Pengguna terakhir, berdasarkan nama dan id, yang telah memperbarui pengelola ini

creation_time

jenis: string

Waktu pembuatan bisnis ini

created_by

jenis: objek JSON

Nama pengguna dan id yang membuat pengelola ini

Memperbarui Pengelola Bisnis

Perbarui kolom di pengelola bisnis dengan menggunakan permintaan POST ke https://graph.facebook.com/{API_VERSION}/{BUSINESS_ID}. Sebagai contoh, ubah nama bisnis:

curl \
-F "name=My Actual Business Name" \
-F "access_token=<ACCESS_TOKEN>" \
"https://graph.facebook.com/<API_VERSION>/<BUSINESS_ID>/"

Ubah vertikal bisnis dengan membuat permintaan POST berikut:

curl \
-F "vertical=RETAIL" \
-F "access_token=<ACCESS_TOKEN>" \
"https://graph.facebook.com/<API_VERSION>/<BUSINESS_ID>/"

Anda memiliki opsi berikut:

Nama Deskripsi

name

Wajib.

Nama Bisnis

primary_page

ID halaman utama yang terkait dengan pengelola bisnis ini.

Anda dapat memperbarui halaman utama dengan membuat permintaan POST berikut. Halaman utama harus dimiliki oleh pengelola bisnis.

curl \
  -F "primary_page=<PAGE_ID>" \
  -F "access_token=<ACCESS_TOKEN>" \
  "https://graph.facebook.com/<API_VERSION>/<BUSINESS_ID>/"

Anda juga dapat memperbarui semua hal di atas dalam satu permintaan POST:

curl \
  -F "name=My Actual Business Name" \
  -F "vertical=RETAIL" \
  -F "primary_page=<PAGE_ID>" \
  -F "access_token=<ACCESS_TOKEN>" \
  "https://graph.facebook.com/<API_VERSION>/<BUSINESS_ID>/"

Mengelola Orang dan Peran

Ada dua jenis peran dalam Pengelola Bisnis:

Nama Konstanta API Deskripsi

Admin

ADMIN

  • Dapat mengontrol semua aspek bisnis, termasuk memodifikasi atau menghapus akun dan menambahkan atau menghapus orang dari daftar karyawan.
  • Mempunyai akses READ dan WRITE ke semua aset yang terhubung dengan Pengelola Bisnis.

Karyawan

EMPLOYEE

  • Dapat melihat semua informasi di pengaturan bisnis dan diberi peran oleh admin bisnis. Tidak dapat melakukan perubahan apa pun, kecuali menambahkan Halaman atau akun iklan di mana pengguna ini menjadi admin bisnis.
  • Mempunyai akses READ ke semua aset yang terhubung dengan Pengelola Bisnis.

Untuk informasi selengkapnya tentang peran, lihat Menyiapkan peran katalog di Pengelola Bisnis.

Pada awalnya, kreator Bisnis adalah satu-satunya pengguna pada Bisnis dan merupakan Admin.

Mengundang Orang

Untuk menambahkan rekan kerja ke bisnis, Anda harus mengundang mereka. Untuk mengundang seseorang, berikan alamat email valid yang dapat mereka akses. Pengiriman permintaan untuk menambahkan karyawan ke pengelola bisnis dibatasi. Saat Anda mencapai batas ini, Anda akan mendapatkan kode kesalahan 17 dan Anda harus melanjutkan 24 jam kemudian.

Untuk mengundang seseorang sebagai admin, kirim permintaan POST:

curl \
-F "email=some@email.com" \
-F "role=ADMIN" \
-F "access_token=<ACCESS_TOKEN>" \
"https://graph.facebook.com/<API_VERSION>/<BUSINESS_ID>/business_users"

Untuk mengundang seseorang sebagai karyawan, kirim permintaan POST:

curl \
-F "email=some@email.com" \
-F "role=EMPLOYEE" \
-F "access_token=<ACCESS_TOKEN>" \
"https://graph.facebook.com/<API_VERSION>/<BUSINESS_ID>/business_users"

Facebook mengirimkan undangan email ke alamat email kerja yang Anda tentukan. Orang yang diundang harus memeriksa email dan mengikuti proses pendaftaran. Setelah selesai, Anda dapat melihatnya di daftar Pengguna Anda.

Orang-orang di Pengelola Bisnis

Mulai v2.11, kami memiliki endpoint terpisah untuk mendapatkan pengguna berdasarkan status mereka. Buat permintaan GET untuk mengambil setiap grup pengguna. Untuk mendapatkan semua pengguna Bisnis (Harap perhatikan bahwa Akses Lanjutan diperlukan.):

curl "https://graph.facebook.com/<API_VERSION>/<BUSINESS_ID>/business_users?access_token=<ACCESS_TOKEN>"

Untuk mendapatkan pengguna sistem, dengan akses level sistem:

curl "https://graph.facebook.com/<API_VERSION>/<BUSINESS_ID>/system_users?access_token=<ACCESS_TOKEN>"

Untuk mendapatkan pengguna tertunda yang diundang untuk mengakses bisnis, tetapi yang belum menerima:

curl "https://graph.facebook.com/<API_VERSION>/<BUSINESS_ID>/pending_users?access_token=<ACCESS_TOKEN>"

Endpoint menampilkan pengguna aktif, tertunda, maupun sistem untuk Bisnis Anda. Contoh:

{
  "data": [
    {
      "id": "<BUSINESS_ID>",
      "name": "Alpha MK",
      "email": "some@email.com",
      "role": "EMPLOYEE",
    }
  ]
}

Hasil untuk pengguna tertunda akan terlihat seperti ini:

{
  "data": [
    {
      "id": "<BUSINESS_ID>",
      "email": "some@email.com",
      "role": "EMPLOYEE",
      "status": "PENDING",
      "owner": {
        "id": "USER_ID",
        "name": "Generic Emporium"
      }
    }
  ]
}

Definisi untuk kolom yang ditampilkan adalah sebagai berikut:

Nama Deskripsi

id

jenis: long

ID pengguna ini masuk dalam lingkup Bisnis ini.

name

jenis: string

Nama pengguna ini pada Bisnis

business

jenis: objek JSON

Pengelola Bisnis yang memiliki pengguna ini

first_name

jenis: string

Nama depan pengguna ini pada bisnis ini

last_name

jenis: string

Nama belakang pengguna pada bisnis ini

title

jenis: string

Jabatan pengguna pada bisnis ini

role

jenis: string

Peran yang dimiliki orang ini untuk bisnis ini. EMPLOYEE atau ADMIN

email

jenis: string

Alamat email pengguna

Mengubah Peran

Untuk mengubah peran pengguna aktif pada Bisnis Anda, berikan ID Pengguna untuk pengguna tersebut. Contohnya, Anda dapat meningkatkan peran seorang Karyawan menjadi Admin dengan permintaan POST ini:

curl \
  -F "role=ADMIN" \
  -F "access_token=<ACCESS_TOKEN>" \
  "https://graph.facebook.com/<API_VERSION>/<BUSINESS_SCOPED_USER_ID>"

Untuk mengubah peran seseorang dari Admin menjadi Karyawan, buat permintaan POST:

curl \
  -F "role=EMPLOYEE" \
  -F "access_token=<ACCESS_TOKEN>" \
  "https://graph.facebook.com/<API_VERSION>/<BUSINESS_SCOPED_USER_ID>"

Anda dapat mengubah peran untuk pengguna tertunda dengan permintaan POST ini:

curl \
  -F "role=EMPLOYEE" \
    -F "access_token=<ACCESS_TOKEN>" \
"https://graph.facebook.com/<API_VERSION>/<PENDING_USER_ID>"

Menghapus Pengguna

Hapus izin yang diberikan kepada seseorang berdasarkan keanggotaan di pengelola bisnis Anda. Batasi akses ke akun iklan dan halaman. Jika pengguna memiliki akses ke akun iklan atau halaman di luar Pengelola Bisnis Anda, izin tersebut tidak berubah. Contohnya, seseorang mungkin telah menambahkan diri mereka sendiri atau mereka memiliki akses melalui pengelola bisnis lain

Untuk menghapus pengguna aktif dari bisnis Anda, buat panggilan DELETE:

curl \
  -X DELETE \
  -F "access_token=<ACCESS_TOKEN>" \
  "https://graph.facebook.com/<API_VERSION>/<BUSINESS_SCOPED_USER_ID>"

Untuk membatalkan pengguna tertunda dengan permintaan DELETE:

curl \
  -X DELETE \
  -F "access_token=<ACCESS_TOKEN>" \
  "https://graph.facebook.com/<API_VERSION>/<PENDING_USER_ID>"

Langkah ini akan menghapus pengguna dari Bisnis Anda dan menghapus akses ke aset Bisnis Anda.

Dapatkan Objek Koneksi

Dokumen Referensi

Objek Koneksi adalah objek Facebook (contohnya, halaman, aplikasi, dan sebagainya) yang dikelola oleh seorang administrator. Seorang administrator dapat berupa pengguna atau bisnis, atau dalam kasus aplikasi, developer atau pengiklan. Jenis objek koneksi adalah:

  • Halaman dan Tempat
  • Acara
  • Aplikasi
  • Domain

Lihat contoh kueri dan pelajari selengkapnya di Objek Koneksi.

Invoice

Dokumen Referensi

Dengan Business Manager API, Anda dapat melihat dan mengelola sumber kredit yang terkait dengan bisnis. API mencoba ulang semua invoice yang terlihat oleh Pengelola Bisnis. Hal ini berarti bahwa semua invoice yang menjadi tanggung jawab Pengelola Bisnis ini akan terlihat melalui API, bukan hanya invoice milik ID bisnis perorangan.

Lini Kredit Normal Milik Pengelola Bisnis

Untuk mitra Marketing API yang telah mengaktifkan invoice, Anda dapat memanfaatkan Lini Kredit Normal Milik Pengelola Bisnis.

Mitra Marketing Facebook (FBMP) harus menghubungi perwakilan penjualan mereka untuk menyiapkan pengelola bisnis Anda agar bisa mendapatkan kredit. Harap pastikan untuk meminta Lini Kredit Normal Milik Pengelola Bisnis. Setelah ini disiapkan, Anda dapat mulai menggunakan API pembuatan akun iklan untuk mulai membuat akun iklan. Biaya akan dibebankan pada lini kredit pengelola bisnis Anda.

Untuk akun iklan yang dibuat melalui API berikut, kami akan mendistribusikan kredit secara dinamis ke seluruh akun dan memperbarui batas kredit serta pengeluaran agar tidak mencapai batas kredit. Anda juga akan dapat melihat ringkasan kredit yang tersedia dan jumlah kredit pada setiap akun iklan.

Saat ini, kami hanya mendukung liabilitas normal. Liabilitas sekuensial tidak didukung. Proses pengaturannya tidak akan berubah.

Pembuatan Invoice Akhir Bulan

Setelah lini kredit Anda diatur untuk bisnis dan bisnis menggunakannya untuk menjalankan iklan, kami akan membuat invoice akhir bulan untuk akun bisnis tersebut. Untuk melihat invoice bisnis, Anda memerlukan peran keuangan. Untuk administrator normal dan karyawan bisnis, Anda dapat menetapkan izin pada People di Pengelola Bisnis. Anda juga dapat menetapkan izin keuangan kepada pengguna sistem dengan menggunakan Pengelola Bisnis.

Untuk mengambil invoice di akun bisnis menggunakan API, kirim permintaan GET:

curl -G \
-d "access_token=<ACCESS_TOKEN>" \
"https://graph.facebook.com/<API_VERSION>/<BUSINESS_ID>/business_invoices?start_date=2017-01-01&end_date=2017-04-01"

Contoh hasilnya akan terlihat seperti ini:

{
  "business_invoices": {
    "data": [
      {
        "id": "1659175694099710",
        "billing_period": "2017-03-01"
      },
      {
        "id": "1303851778395619",
        "billing_period": "2017-01-01"
      },
      {
        "id": "1415846861611329",
        "billing_period": "2017-02-01"
      }
    ],
    "paging": {
      "cursors": {
        "before": "MAZDZD",
        "after": "MgZDZD"
      }
    }
  },
  "id": "249554531892085"
}

Anda bisa mendapatkan detail invoice pada level kampanye dengan permintaan ini:

curl -G \
-d "access_token=<ACCESS_TOKEN>" \
"https://graph.facebook.com/<API_VERSION>/<BUSINESS_ID>/business_invoices?fields=billed_amount_details,billing_period,entity,id,invoice_id,payment_term,type,campaigns&start_date=2019-06-01&end_date=2019-07-01"

Tanggapannya sama dengan ini:

{
  "business_invoices": {
    "data": [
      {
        "billed_amount_details": {
          "currency": "USD",
          "net_amount": "387.70",
          "tax_amount": "0.00",
          "total_amount": "387.70"
        },
        "billing_period": "2017-03-01",
        "entity": "FBUS",
        "id": "1659175694099710",
        "invoice_id": "22736800",
        "liability_type": "Normal",
        "invoice_type": "Invoice",
        "payment_term": "CUSTOMER",
        "type": "Invoice",
        "campaigns": {
          "data": [
            {
              "campaign_id": "6056967798500",
              "campaign_name": "Nhận ưu đãi",
              "tags": [
                "hello2"
              ],
              "billed_amount_details": {
                "currency": "USD",
                "net_amount": "207.62",
                "tax_amount": "0.00",
                "total_amount": "207.62"
              }
            },
            {
              "campaign_id": "6056958052500",
              "campaign_name": "Nhận ưu đãi",
              "billed_amount_details": {
                "currency": "USD",
                "net_amount": "180.08",
                "tax_amount": "0.00",
                "total_amount": "180.08"
              }
              "impressions": 100,
              "clicks": 50,
              "conversions": 30
            }
          ]
        }
      },
      {
        "billed_amount_details": {
          "currency": "USD",
          "net_amount": "382.99",
          "tax_amount": "0.00",
          "total_amount": "382.99"
        },
        ......
    "paging": {
      "cursors": {
        "before": "MAZDZD",
        "after": "MgZDZD"
      }
    }
  },
  "id": "1515766328651000"
}

Anda juga dapat mengambil kolom invoice tambahan:

  • invoice_date - Tanggal saat Facebook membuat invoice
  • due_date - Tanggal invoice jatuh tempo
  • payment_status - Menunjukkan apakah invoice Paid, Unpaid, atau Partially Paid
  • amount_due - Jumlah uang yang jatuh tempo, dan tunggakan, pada invoice
  • download_uri - Unduh PDF invoice di URI ini

API Sumber Pendanaan

Untuk mengambil sumber pendanaan kredit yang diperpanjang yang terkait dengan pengelola bisnis, kirim permintaan GET ini.

curl "https://www.graph.facebook.com/<API_VERSION>/<BUSINESS_ID>/extendedcredits"

Untuk mengatur sumber pendanaan untuk bisnis, buka bagian pengaturan bisnis Anda di Pengelola Bisnis.

Alokasi Kredit Dinamis

Alokasi Kredit Dinamis, dikenal juga dengan DCAF, adalah sistem alokasi kredit kami untuk menyesuaikan kredit yang tersedia secara berkala per akun iklan. Skrip otomatis kami berjalan kira-kira setiap 30 menit dan mengambil kredit Anda yang tersedia serta mendistribusikannya secara merata di semua akun aktif Anda yang diaktifkan untuk DCAF. Kredit yang tersedia mencakup total kredit yang disetujui dikurangi total saldo tertunggak. Alokasi ini membantu mengelola pengeluaran di level akun iklan Anda dan mengalokasikan pendanaan untuk setiap akun iklan.

Bisnis juga dapat "menonaktifkan" akun iklan yang ditagih dan menghapus akun iklan dari daftar yang memerlukan penetapan kredit. Bisnis tidak perlu lagi meminta Facebook mengelola status ini.