Business Management APIs

Fungsi Bisnis ke Bisnis

Per 8 Juni 2021, akses ke endpoint ini dibatasi. Aplikasi tanpa akses akan menerima pesan kesalahan.

Meminta Akses ke Aset

Pengelola Bisnis dapat meminta akses ke akun iklan atau Halaman yang dimiliki oleh Pengelola Bisnis lain. Mereka harus menentukan tugas yang ingin ditetapkan di dalam permintaan.

Menetapkan bisnis ke sebuah Halaman memerlukan token halaman, sebagai contoh:

curl 
  -F "business=<BUSINESS_ID>"
  -F "permitted_tasks=['MODERATE', 'ADVERTISE', 'ANALYZE']"   
  "https://graph.facebook.com/<API_VERSION>/<PAGE_ID>/agencies?access_token=<ACCESS_TOKEN>"

Untuk meminta akses AGENCY, Anda harus memberikan permitted_tasks dalam permintaan. Anda hanya dapat mengirimkan permintaan ke aset ke Pengelola Bisnis yang ingin Anda setujui dan mereka harus sudah mengetahui bisnis Anda.

Contoh, sebuah bisnis yang memerlukan akses ke adaccount_id dan harus dapat menetapkan karyawannya sebagai ['ADVERTISE', 'ANALYZE'] akan membuat panggilan POST ini:

curl \
  -F "adaccount_id=act_<AD_ACCOUNT_ID>" \
  -F "permitted_tasks=['ADVERTISE','ANALYZE']" \
  "https://graph.facebook.com/<API_VERSION>/<BUSINESS_ID>/client_ad_accounts?access_token=<ACCESS_TOKEN>"

Sama seperti Halaman, jika Anda ingin menetapkan tugas ['ADVERTISE', 'ANALYZE'] untuk Halaman yang tidak dimiliki oleh seseorang:

curl \
  -F "page_id=<PAGE_ID>" \
  -F "permitted_tasks=['ADVERTISE','ANALYZE']" \
  "https://graph.facebook.com/<API_VERSION>/<BUSINESS_ID>/client_pages?access_token=<ACCESS_TOKEN>"

Panggilan ini akan mengirimkan notifikasi ke masing-masing admin akun iklan atau Halaman, yang memintanya untuk menerima permintaan akses tersebut. Masing-masing admin akan melihat notifikasi di Pengelola Iklan atau Pengelola Halaman. Mereka juga dapat menerima permintaan di antarmuka pengguna. Jika Anda ingin melihat permintaan yang tertunda melalui API, buatlah permintaan GET dan periksa PENDING pada kolom access_status.

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

Tanggapan:

"data": [
 {
    "name": "Random Page", 
    "page_permissions": [
    {
    "id": "1900952844321", 
    "permitted_tasks": [
        'MANAGE',
        'CREATE_CONTENT', 
        'MODERATE',  
        'ADVERTISE', 
        'ANALYZE',
    ], 
    "access_status": "CLIENT_RESPONSE_PENDING", 
    "access_requested_time": "2014-01-07T23:26:09+0000", 
    "access_updated_time": "2014-01-07T23:26:09+0000"
    }
    ], 
    "id": "190137931178903"
 },

Memberikan Akses ke Aset untuk Pengelola Bisnis Lainnya

Langkah ini juga dikenal sebagai menambahkan Agensi ke objek.

Untuk menerima permintaan akses dari objek yang Anda miliki dari pengelola bisnis lain, atau untuk memberikan akses ke salah satu objek yang Anda miliki kepada pengelola bisnis lain, Anda harus menentukan bisnis dan daftar tugas yang aksesnya harus mereka miliki.

Jika token akses yang digunakan untuk melakukan panggilan API milik pengguna atau pengguna sistem yang dapat mengakses aset yang diminta melalui bisnis, akses ke aset hanya dapat diberikan jika bisnis ini adalah OWNER aset. Anda tidak dapat memberikan akses ke aset jika peran Anda hanya AGENCY.

Contoh, untuk memberi seseorang akses ke akun iklan yang menggunakan tugas [ADVERTISE,ANALYZE], gunakan permintaan POST ini:

curl \
  -F "business=<BUSINESS_ID>" \
  -F "permitted_tasks=['ADVERTISE', 'ANALYZE']" \
  "https://graph.facebook.com/<API_VERSION>/act_<AD_ACCOUNT_ID>/agencies?access_token=<ACCESS_TOKEN>"

Untuk memberikan akses ke halaman Anda dengan [ADVERTISE], [MODERATE] dan [ANALYZE] kepada suatu bisnis:

curl \
  -F "business=<BUSINESS_ID>" \
  -F "permitted_tasks=['MODERATE', 'ADVERTISE', 'ANALYZE']" \
  "https://graph.facebook.com/<API_VERSION>/<PAGE_ID>/agencies?access_token=<ACCESS_TOKEN>"

Dalam hal pemberian akses ke akun iklan, tinjauan dari admin bisnis lain terkadang diperlukan sebagai langkah keamanan. Tinjauan ini dapat disetujui dengan membuka https://business.facebook.com/settings/requests/admin_reviews. Dalam hal ini, tanggapan akan memiliki bidang tambahan yang menunjukkan bahwa tinjauan diperlukan.

{
  "success": true,
  "requires_admin_approval": true
}

Admin Halaman juga dapat menerima permintaan akses agensi di dalam tab Manage Admin Roles di Pengaturan Halaman di facebook.com.

Menghapus Akses ke Aset

Langkah ini juga dikenal dengan menghapus agensi dari bisnis. Untuk menghapus akses pengelola bisnis dari akun iklan Anda:

curl \
  -X DELETE \
  -F "business=<BUSINESS_ID>" \
  "https://graph.facebook.com/<API_VERSION>/act_<AD_ACCOUNT_ID>/agencies?access_token=<ACCESS_TOKEN>"

Demikian pula, untuk menghapus akses Bisnis dari Halaman Anda:

curl \
  -X DELETE \
  -F "business=<BUSINESS_ID>" \
  "https://graph.facebook.com/<API_VERSION>/<PAGE_ID>/agencies?access_token=<ACCESS_TOKEN>"

Melihat Akses Agensi

Untuk melihat semua bisnis yang dapat mengakses akun iklan Anda dengan panggilan GET:

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

Untuk melihat semua bisnis yang memiliki akses ke halaman Anda:

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

Untuk melihat semua bisnis yang memiliki akses ke aset bisnis Anda:

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

Melihat Akses Klien

Untuk melihat semua bisnis yang telah memberi Anda akses ke salah satu atau beberapa akun iklan atau halamannya, gunakan panggilan GET ini:

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

Managing Your Relationship as an Ad Agency Acting on Behalf of Another Business

These APIs allow you to manage the relationship between your Ad Accounts and the businesses for which you are acting on behalf of (OBO). Creating these relationships allows you to access custom audiences for the business and use of the audience overlap tool.

View OBO Request Details

To view the details of an OBO request, make this GET request:

curl -G \
  -F "access_token=<ACCESS_TOKEN>" \
  "https://graph.facebook.com/<API_VERSION>/<OBO_REQUEST_ID>?fields=id,receiving_business,requesting_business,status,business_owned_object"

The response contains the details of the OBO request and looks like this:

{
  "id": "1111111111",
  "receiving_business": {
    "id": "2222222222",
    "name": "Example Business Name"
  },
  "requesting_business": {
    "id": "3333333333",
    "name": "Example Business Name"
  },
  "status": "IN_PROGRESS",
  "business_owned_object": "1111111111"
}

Delete OBO Request

To cancel a pending request to act OBO another business, make this DELETE request:

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

The response, indicating success or failure, looks like this:

{
  "success": "true" 
}

View the Status of OBO Requests for an Ad Account

To view the status of requests to act OBO another business for an Ad account, make this GET request:

curl -G \
  -F "access_token=<ACCESS_TOKEN>" \
  "https://graph.facebook.com/<API_VERSION>/act_<AD_ACCOUNT_ID>/onbehalf_requests?
    fields=id,status,receiving_business,requesting_business&status=<STATUS>"

The status parameter in the request must be APPROVE, DECLINE, or IN_PROGRESS.

The response contains an array with the OBO request objects for an Ad account matching the requested status.

Example response:

{
  "data": [
    {
      "id": "1111111111",
      "status": "IN_PROGRESS",
      "receiving_business": {
        "id": "2222222222",
        "name": "Example Business Name"
      },
      "requesting_business": {
        "id": "3333333333",
        "name": "Example Business Name"
      }
    }
  ]
}

View OBO Requests Received From Other Businesses

To view requests of IN_PROGRESS OBO requests sent to your business, make this GET request:

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

The response contains the IN_PROGRESS OBO request IDs and looks like this:

{
  "data": [
    {
      "id": "1111111111"
    },
    {
      "id": "2222222222"
    },
    {
      "id": "3333333333"
    }
  ]
}

View Pending OBO Requests Sent by Your Business

To view OBO requests that were sent by your business that are still in the IN_PROGRESS state, make this GET request:

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

The response contains the IN_PROGRESS OBO request IDs and looks like this:

{
  "data": [
    {
      "id": "1111111111"
    },
    {
      "id": "2222222222"
    },
    {
      "id": "3333333333"
    }
  ]
}

Pelajari Selengkapnya