マーケティングAPI
グラフAPIバージョン

Business

Represent a specific business on Facebook. Make the API call to the business ID.

To find the ID of a business, go to Business Manager > Business Settings > Business Info. There, you will see information about the business, including the ID.

読み取り

Represents a business on Facebook. Includes any specified properties and assets belonging to the business.

2021年9月14日以降、以下のフィールドで、エンドポイントの必須アクセス許可を持たないアプリからバージョン12.0以降の呼び出しをするとエラーがスローされるようになります。この変更は、2021年12月13日にすべてのバージョンに適用されます。

  • collaborative_ads_managed_partner_business_info

例

Graph API Explorer
GET /v19.0/{business-id} HTTP/1.1
Host: graph.facebook.com
/* PHP SDK v5.0.0 */
/* make the API call */
try {
  // Returns a `Facebook\FacebookResponse` object
  $response = $fb->get(
    '/{business-id}',
    '{access-token}'
  );
} catch(Facebook\Exceptions\FacebookResponseException $e) {
  echo 'Graph returned an error: ' . $e->getMessage();
  exit;
} catch(Facebook\Exceptions\FacebookSDKException $e) {
  echo 'Facebook SDK returned an error: ' . $e->getMessage();
  exit;
}
$graphNode = $response->getGraphNode();
/* handle the result */
/* make the API call */
FB.api(
    "/{business-id}",
    function (response) {
      if (response && !response.error) {
        /* handle the result */
      }
    }
);
/* make the API call */
new GraphRequest(
    AccessToken.getCurrentAccessToken(),
    "/{business-id}",
    null,
    HttpMethod.GET,
    new GraphRequest.Callback() {
        public void onCompleted(GraphResponse response) {
            /* handle the result */
        }
    }
).executeAsync();
/* make the API call */
FBSDKGraphRequest *request = [[FBSDKGraphRequest alloc]
                               initWithGraphPath:@"/{business-id}"
                                      parameters:params
                                      HTTPMethod:@"GET"];
[request startWithCompletionHandler:^(FBSDKGraphRequestConnection *connection,
                                      id result,
                                      NSError *error) {
    // Handle the result
}];
グラフAPIを使用する方法については、グラフAPIの使用ガイドをご覧ください。

パラメーター

このエンドポイントにはパラメーターがありません。

フィールド

フィールド説明
id
numeric string

The business account ID.

デフォルト
block_offline_analytics
bool

Specifies whether offline analytics for business is blocked.

collaborative_ads_managed_partner_business_info
ManagedPartnerBusiness

collaborative_ads_managed_partner_business_info

collaborative_ads_managed_partner_eligibility
BusinessManagedPartnerEligibility

collaborative_ads_managed_partner_eligibility

created_by
BusinessUser|SystemUser

The creator of this business.

created_time
datetime

The creation time of this business.

extended_updated_time
datetime

The update time of the extended credits for this business.

is_hidden
bool

If true, indicates the business is hidden.

link
string

URI for business profile page.

name
string

The name of the business.

デフォルト
payment_account_id
numeric string

The ID for the payment account of this business.

primary_page
Page

The primary Facebook Page for this business.

profile_picture_uri
string

The profile picture URI of the business.

timezone_id
unsigned int32

This business's timezone.

two_factor_type
enum

The two factor type authentication used for this business.

updated_by
BusinessUser|SystemUser

The person's name who last updated this business.

updated_time
datetime

The time when this business was last updated.

verification_status
enum

Verification status for this business.

vertical
string

The vertical industry that this business associates with, or belongs to.

vertical_id
unsigned int32

The ID for the vertical industry.

エッジ

エッジ説明
ad_studies
Edge<AdStudy>

The studies this business has access to, such as any advertising lift studies or split testing studies.

adnetworkanalytics
Edge<AdNetworkAnalyticsSyncQueryResult>

Audience Network query for this publisher entity.

adnetworkanalytics_results
Edge<AdNetworkAnalyticsAsyncQueryResult>

Obtain the results of an asynchronous Audience Network query for this publisher entity.

ads_reporting_mmm_reports
Edge<AdsReportBuilderMMMReport>

Marketing mix modeling (MMM) reports generated for this business

ads_reporting_mmm_schedulers
Edge<AdsReportBuilderMMMReportScheduler>

Marketing mix modeling (MMM) reports schedulers for this business

adspixels
Edge<AdsPixel>

The business has access to these pixels.

agencies
Edge<Business>

Agencies associated with this business.

an_placements
Edge<AdPlacement>

Placements used by this Audience Network business.

business_asset_groups
Edge<BusinessAssetGroup>

Business asset groups owned by this business. The business can grant permissions to assets in this group.

business_invoices
Edge<OmegaCustomerTrx>

The extended credit invoices of this business.

business_users
Edge<BusinessUser>

Business users associated with this business. Includes employees and admins at the business.

client_apps
Edge<Application>

This business has access to these client apps.

client_offsite_signal_container_business_objects
Edge<OffsiteSignalContainerBusinessObject>

The business has access to these client offsite signal container business objects

client_pages
Edge<Page>

This business has access to these client pages.

client_pixels
Edge<AdsPixel>

This business has access to these client pixels.

client_product_catalogs
Edge<ProductCatalog>

This business has access to these client product catalogs.

client_whatsapp_business_accounts
Edge<WhatsAppBusinessAccount>

WhatsApp business accounts that were shared to this business.

clients
Edge<Business>

Clients of this business.

collaborative_ads_collaboration_requests
Edge<CPASCollaborationRequest>

All Collaborative Ads. collaboration requests initiated by the business.

collaborative_ads_suggested_partners
Edge<CPASAdvertiserPartnershipRecommendation>

Collaborative Ads suggested partners for a business.

commerce_merchant_settings
Edge<CommerceMerchantSettings>

Commerce Merchant Settings belonging to this business.

event_source_groups
Edge<EventSourceGroup>

The business owns these event source groups. Includes various signals sources such as pixels.

extendedcredits
Edge<ExtendedCredit>

Extended credits for this business.

initiated_audience_sharing_requests
Edge<BusinessAssetSharingAgreement>

The audience sharing requests initiated by this business.

instagram_accounts
Edge<InstagramUser>

This business has access to these Instagram accounts.

openbridge_configurations
Edge<OpenBridgeConfiguration>

Get all the openbridge configurations associated to this business

owned_apps
Edge<Application>

This business owns these apps.

owned_businesses
Edge<Business>

This business aggregates and manages these client businesses.

owned_instagram_accounts
Edge<InstagramUser>

This business owns these Instagram accounts.

owned_offsite_signal_container_business_objects
Edge<OffsiteSignalContainerBusinessObject>

owned_offsite_signal_container_business_objects

owned_pages
Edge<Page>

This business owns these pages.

owned_pixels
Edge<AdsPixel>

This business owns these pixels.

owned_product_catalogs
Edge<ProductCatalog>

This business owns these product catalogs.

owned_whatsapp_business_accounts
Edge<WhatsAppBusinessAccount>

This business owns these WhatsApp Business Accounts.

pending_client_ad_accounts
Edge<BusinessAdAccountRequest>

This business requested access to these client ad accounts and is pending approval.

pending_client_apps
Edge<BusinessApplicationRequest>

This business requested access to these client apps and is pending approval.

pending_client_pages
Edge<BusinessPageRequest>

This business requested access to these client pages and is pending approval.

pending_owned_ad_accounts
Edge<BusinessAdAccountRequest>

This business requested ownership of these ad accounts and is pending approval.

pending_owned_pages
Edge<BusinessPageRequest>

This business requested ownership of these pages and is pending approval.

pending_shared_offsite_signal_container_business_objects
Edge<OffsiteSignalContainerBusinessObject>

This business received sharing requests for these offsite signal container business objects and is pending for approval.

pending_users
Edge<BusinessRoleRequest>

Admin for this business invited this user to the business. Pending user approval.

preverified_numbers
Edge<WhatsAppBusinessPreVerifiedPhoneNumber>

Edge to get list of all pre-created phone numbers for this business

received_audience_sharing_requests
Edge<BusinessAssetSharingAgreement>

The audience sharing requests received by this business.

self_certified_whatsapp_business_submissions
Edge<WhatsAppBusinessPartnerClientVerificationSubmission>

Business Service Providers can submit their client information for verification on WhatsApp Business Platform. This endpoint returns statuses, submitted info, and rejection reasons for the submissions.

system_users
Edge<SystemUser>

The business's system users.

エラーコード

エラー詳細
104Incorrect signature
368The action attempted has been deemed abusive or is otherwise disallowed
100Invalid parameter
190Invalid OAuth 2.0 Access Token
200Permissions error
2635You are calling a deprecated version of the Ads API. Please update to the latest version.
2500Error parsing graph query

作成

To create other Business Managers, your business needs to obtain BUSINESS_MANAGEMENT during the app review process. If your app is in development mode, you can surpass this requirement, but to create only two child businesses.

china_business_onboarding_attributionsのエッジにPOSTリクエストを以下のパスで送信できます:
このエッジにPOSTする場合、a Businessが作成されます。

パラメーター

このエンドポイントにはパラメーターがありません。

戻り値の型

Struct {
id: numeric string,
link_with_id: string,
}

エラーコード

エラー詳細
200Permissions error
businessesのエッジにPOSTリクエストを以下のパスで送信できます:
このエッジにPOSTする場合、a Businessが作成されます。

パラメーター

パラメーター説明
child_business_external_id
string

child_business_external_id

email
string

The business email of the business admin

name
string

Username

必須
primary_page
page ID

Primary Page ID

sales_rep_email
string

Sales Rep email address

survey_business_type
enum {AGENCY, ADVERTISER, APP_DEVELOPER, PUBLISHER}

Business Type

survey_num_assets
int64

Number of Assets in the business

survey_num_people
int64

Number of People that will work on the business

timezone_id
int64

Timezone ID

vertical
enum {NOT_SET, 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, NON_PROFIT, RESTAURANT, HEALTH, LUXURY, OTHER}

Vertical ID

必須

戻り値の型

このエンドポイントはリード‐アフター‐ライトに対応し、idによって表されたノードを戻り値の型で読み込みます。
Struct {
id: numeric string,
}

エラーコード

エラー詳細
368The action attempted has been deemed abusive or is otherwise disallowed
3947You are trying to create a Business Manager with the same name as one you are already a part of. Please pick a different name.
100Invalid parameter
3974The name you chose for this Business Manager is not valid. Try a different name.
3918The Facebook Page you've tried to add is already owned by another Business Manager. You can still request access to this Page, but your request will need to be approved by the Business Manager that owns it.
3973The name you chose for this Business Manager is not valid. Please choose another.
457The session has an invalid origin
42000This Page can't be added because it's already linked to an Instagram business profile. To add this Page to Business Manager, go to Instagram and convert to a personal account or change the Page linked to your business profile.
200Permissions error
owned_businessesのエッジにPOSTリクエストを以下のパスで送信できます:
このエッジにPOSTする場合、a Businessが作成されます。

パラメーター

パラメーター説明
name
string

name

必須
page_permitted_tasks
array<enum {MANAGE, CREATE_CONTENT, MODERATE, MESSAGING, ADVERTISE, ANALYZE, MODERATE_COMMUNITY, MANAGE_JOBS, PAGES_MESSAGING, PAGES_MESSAGING_SUBSCRIPTIONS, READ_PAGE_MAILBOXES, VIEW_MONETIZATION_INSIGHTS, MANAGE_LEADS, PROFILE_PLUS_FULL_CONTROL, PROFILE_PLUS_MANAGE, PROFILE_PLUS_FACEBOOK_ACCESS, PROFILE_PLUS_CREATE_CONTENT, PROFILE_PLUS_MODERATE, PROFILE_PLUS_MODERATE_DELEGATE_COMMUNITY, PROFILE_PLUS_MESSAGING, PROFILE_PLUS_ADVERTISE, PROFILE_PLUS_ANALYZE, PROFILE_PLUS_REVENUE, PROFILE_PLUS_MANAGE_LEADS, CASHIER_ROLE}>

page_permitted_tasks

sales_rep_email
string

sales_rep_email

shared_page_id
page ID

shared_page_id

survey_business_type
enum {AGENCY, ADVERTISER, APP_DEVELOPER, PUBLISHER}

survey_business_type

survey_num_assets
int64

survey_num_assets

survey_num_people
int64

survey_num_people

timezone_id
int64

timezone_id

vertical
enum {NOT_SET, 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, NON_PROFIT, RESTAURANT, HEALTH, LUXURY, OTHER}

vertical

必須

戻り値の型

このエンドポイントはリード‐アフター‐ライトに対応し、idによって表されたノードを戻り値の型で読み込みます。
Struct {
id: numeric string,
}

エラーコード

エラー詳細
100Invalid parameter
368The action attempted has been deemed abusive or is otherwise disallowed
200Permissions error
3974The name you chose for this Business Manager is not valid. Try a different name.

更新中…

/{business_id}にPOSTリクエストを送信してa Businessを更新できます。

パラメーター

パラメーター説明
entry_point
string

entry point of claiming BusinessClaimAssetEntryPoint

name
string

Business's name

primary_page
numeric string or integer

Primary page of this business

timezone_id
int64

Timezone id of this business

two_factor_type
enum{none, admin_required, all_required}

Two-factor type of the business

vertical
enum {NOT_SET, 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, NON_PROFIT, RESTAURANT, HEALTH, LUXURY, OTHER}

Vertical type of the business

戻り値の型

このエンドポイントはリード‐アフター‐ライトに対応し、idによって表されたノードを戻り値の型で読み込みます。
Struct {
id: numeric string,
}

エラーコード

エラー詳細
3974The name you chose for this Business Manager is not valid. Try a different name.
3910You need permission to edit the details of your Business Manager. Please talk to one of your Business Manager admins about changing your role or editing the Business Manager details.
3973The name you chose for this Business Manager is not valid. Please choose another.
3912There was a technical issue and the changes you made to your Business Manager weren't saved. Please try again.
3911You need permission to set up a new Business Manager.
3947You are trying to create a Business Manager with the same name as one you are already a part of. Please pick a different name.
3918The Facebook Page you've tried to add is already owned by another Business Manager. You can still request access to this Page, but your request will need to be approved by the Business Manager that owns it.
100Invalid parameter
368The action attempted has been deemed abusive or is otherwise disallowed
190Invalid OAuth 2.0 Access Token
/{business_id}/managed_businessesにPOSTリクエストを送信してa Businessを更新できます。

パラメーター

パラメーター説明
child_business_external_id
string

child_business_external_id

existing_client_business_id
business ID

Existing client business id provided by the client

name
string

Client business name that's managed by the aggregator business

sales_rep_email
string

Email of sales representative of the business that's managed by the aggregator business

survey_business_type
enum {AGENCY, ADVERTISER, APP_DEVELOPER, PUBLISHER}

Business type of surveyed business that's managed by the aggregator business

survey_num_assets
int64

Number of assets surveyed of business that's managed by the aggregator business

survey_num_people
int64

Number of people surveyed of business that's managed by the aggregator business

timezone_id
int64

Timezone id of business that's managed by the aggregator business

vertical
enum {NOT_SET, 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, NON_PROFIT, RESTAURANT, HEALTH, LUXURY, OTHER}

Business vertical of business that's managed by the aggregator business

戻り値の型

このエンドポイントはリード‐アフター‐ライトに対応し、idによって表されたノードを戻り値の型で読み込みます。
Struct {
id: numeric string,
}

エラーコード

エラー詳細
42004You couldn't create the client business on behalf your client successfully
100Invalid parameter
102Session key invalid or no longer valid

削除中です

You can dissociate a Business from a Business by making a DELETE request to /{business_id}/agencies.

パラメーター

パラメーター説明
business
numeric string or integer

The agency's business.

必須

戻り値の型

Struct {
success: bool,
}

エラーコード

エラー詳細
100Invalid parameter
You can dissociate a Business from a Business by making a DELETE request to /{business_id}/clients.

パラメーター

パラメーター説明
business
numeric string or integer

The client's business.

必須

戻り値の型

Struct {
success: bool,
}

エラーコード

エラー詳細
2635You are calling a deprecated version of the Ads API. Please update to the latest version.
You can dissociate a Business from a Business by making a DELETE request to /{business_id}/pages.

パラメーター

パラメーター説明
page_id
Page ID

Page ID.

必須

戻り値の型

Struct {
success: bool,
}

エラーコード

エラー詳細
3996The page does not belong to this Business Manager.
100Invalid parameter
42001This Page can't be removed because it's already linked to an Instagram business profile. To remove this Page from Business Manager, go to Instagram and convert to a personal account or change the Page linked to your business profile.
368The action attempted has been deemed abusive or is otherwise disallowed
457The session has an invalid origin
190Invalid OAuth 2.0 Access Token
200Permissions error
415Two factor authentication required. User have to enter a code from SMS or TOTP code generator to pass 2fac. This could happen when accessing a 2fac-protected asset like a page that is owned by a 2fac-protected business manager.
You can dissociate a Business from a Business by making a DELETE request to /{business_id}/instagram_accounts.

パラメーター

パラメーター説明
instagram_account
Instagram account/Instagram account v2 ID

Instagram account ID.

必須

戻り値の型

Struct {
success: bool,
}

エラーコード

エラー詳細
100Invalid parameter
190Invalid OAuth 2.0 Access Token
415Two factor authentication required. User have to enter a code from SMS or TOTP code generator to pass 2fac. This could happen when accessing a 2fac-protected asset like a page that is owned by a 2fac-protected business manager.
457The session has an invalid origin
You can dissociate a Business from a Business by making a DELETE request to /{business_id}/ad_accounts.

パラメーター

パラメーター説明
adaccount_id
string

Ad account ID.

必須

戻り値の型

Struct {
success: bool,
}

エラーコード

エラー詳細
100Invalid parameter
You can dissociate a Business from a Business by making a DELETE request to /{business_id}/owned_businesses.

パラメーター

パラメーター説明
client_id
business ID

client_id

必須

戻り値の型

Struct {
success: bool,
}

エラーコード

エラー詳細
3912There was a technical issue and the changes you made to your Business Manager weren't saved. Please try again.
100Invalid parameter
You can dissociate a Business from an AdAccount by making a DELETE request to /act_{ad_account_id}/agencies.

パラメーター

パラメーター説明
business
business ID

SELF_EXPLANATORY

必須

戻り値の型

Struct {
success: bool,
}

エラーコード

エラー詳細
100Invalid parameter
You can dissociate a Business from a User by making a DELETE request to /{user_id}/businesses.

パラメーター

パラメーター説明
business
numeric string or integer

Business ID

戻り値の型

Struct {
success: bool,
}

エラーコード

エラー詳細
3914It looks like you're trying to remove the last admin from this Business Manager. At least one admin is required in Business Manager.
190Invalid OAuth 2.0 Access Token
100Invalid parameter
368The action attempted has been deemed abusive or is otherwise disallowed