Ad Creatives

Retrieve Facebook Ad creatives data grouped by ads with comprehensive creative and ad association information.

This endpoint provides creative-level insights with ad associations, including filtering capabilities for creative attributes.

Dimensions Available:

Creative ID, name, object type, status, optimization type, ad ID, ad created time

Media: Instagram permalink URL, thumbnail URL, title, video ID, image URL

Configuration: URL tags, ad formats (JSON), website link, call to action types (JSON), title text

Targeting: age range (min/max), publisher platforms (JSON)

Positions: Facebook, Instagram, Messenger, Audience Network configurations

Additional: page ID, Instagram user ID, story specifications, reasons to shop, shops bundle

Limitations:

Maximum 5000 records per page

Supports date filtering via dateStart and dateEnd (ISO 8601 format)

Supports sorting via orderBy and orderDirection (ASC/DESC)

Filters:

workspaceId (required)

organizationId (optional)

userId (optional)

integrationName (optional)

dateStart (optional)

dateEnd (optional)

creativeId (optional)

creativeName (optional)

objectType (optional)

optimizationType (optional)

videoId (optional)

adId (optional)

API Key

Adicionar parâmetro em header

x-client-id

Exemplo:

x-client-id: ********************

API Key

Adicionar parâmetro em header

x-client-secret

Exemplo:

x-client-secret: ********************

curl --location --request GET 'https://api.data.v4.marketing/v1/facebook/ads/creatives?workspaceId=workspace_123&organizationId&userId&integrationName&dateStart=2024-01-01&dateEnd=2024-12-31&page&limit&orderBy&orderDirection&creativeId&creativeName&objectType&optimizationType&videoId&adId' \ --header 'x-client-id: <api-key>' \ --header 'x-client-secret: <api-key>'

{ "data": [ { "creative_id": "string", "creative_name": "string", "object_type": "string", "status": "string", "ad_id": "string", "ad_created_time": "2019-08-24T14:15:22.123Z", "instagram_permalink_url": "string", "thumbnail_url": "string", "title": "string", "video_id": "string", "image_url": "string", "url_tags": "string", "optimization_type": "string", "ad_formats": {}, "website_link": "string", "call_to_action_types": {}, "title_text": "string", "age_max": 0, "age_min": 0, "publisher_platforms": {}, "facebook_positions": {}, "instagram_positions": {}, "messenger_positions": {}, "audience_network_positions": {}, "reasons_to_shop": true, "shops_bundle": true, "page_id": "string", "instagram_user_id": "string", "story_spec_link": "string", "story_spec_link_name": "string", "workspace_id": "string", "organization_id": "string", "user_id": "string", "document_id": "string", "integration_name": "string", "inserted_at": "2019-08-24T14:15:22.123Z" } ], "meta": { "page": 0, "limit": 0, "hasNextPage": true, "hasPreviousPage": true } }

Requisição

Respostas