Ads.updateAdGroups

From Facebook Developer Wiki

Jump to: navigation, search

Contents

Description

Note: This functionality is part of a limited beta program. If you’re interested in participating in the beta test, please contact your Facebook Advertising Account Manager. If you don’t yet have a Facebook Advertising Account Manager, you can request support at http://www.facebook.com/business/contact.php.

This API call is used to update existing AdGroups.

Parameters

RequiredNameTypeDescription
required api_key string The application key associated with the calling application. If you specify the API key in your client, you don't need to pass it with every call.
session_key string The session key of the logged in user. The session key is automatically included by our PHP client.
call_id float The request's sequence number. Each successive call for any session must use a sequence number greater than the last. We suggest using the current time in milliseconds, such as PHP's microtime(true) function. If you specify the call ID in your client, you don't need to pass it with every call.
sig string An MD5 hash of the current request and your secret key, as described in the How Facebook Authenticates Your Application. Facebook computes the signature for you automatically.
v string This must be set to 1.0 to use this version of the API. If you specify the version in your client, you don't need to pass it with every call.
account_id int The Facebook Ads account ID. The account ID must be one of the account IDs the session user can access.
adgroup_specs array Each element of the array should be a JSON string of ads.adgroup_specs that you would like to update. The adgroup_id is required within the adgroup_specs. The name, max_mid, ad_status attributes are editable, only pass the attribute if you want to update it.
optional No optional parameters

Example Requests

$facebook->api_client->ads_createAdGroups(987654, [{"adgroup_id":123456,"name":"Updated"}])

Response

The call returns arrays of successfully created AdGroups as well as an array of those that failed. This is what the response would look like for successfully creating on AdGroup 

 array(
   'updated_adgroups' =>
     array (
      0 => 6002340764763,),
   'failed_adgroups' =>
     array (),
 )



Failed adgroups will return something similar to this:

 array (
   'updated_adgroups' => 
      array (),
   'failed_adgroups' => 
      array (
        0 => 'Invalid parameter: adgroup_spec["name"]',
      ),
 )

Error Codes

CodeDescription
1 An unknown error occurred. Please resubmit the request.
4 The application has reached the maximum number of requests allowed. More requests are allowed once the time window has completed.
100 One of the parameters specified was missing or invalid.
200 Permissions error.
801 Data quota exceeded.
805 Database error.
Retrieved from "http://wiki.developers.facebook.com/index.php/Ads.updateAdGroups"
reference