Documentación
superleads.mx
Documentación › Referencia de la API › Ad Publishing

Ad Publishing

Referencia de la API · ☕ 49 min de lectura
Actualizado el 19 Jun 2026

Ad Manager API

Documentación de la API de Ad-publishing

Servidor base: https://services.leadconnectorhq.com

Endpoints

GET /ad-publishing/facebook/reporting

Obtener reporting data Retrieve aggregated Facebook ad reporting metrics for a location

Scopes requeridos: adPublishing.readonly

Parametros: - Versión (header, string) (requerido) — Versión de la API - locationId (query, string) (requerido) — Identificador de sede - fields (query, array) (requerido) — Reporting fields. Pass as comma-separated values on the wire (e.g. ?fields=impressions,clicks). - groupBy (query, string) (requerido) — Time grouping interval - startDate (query, string) (requerido) — Fecha de inicio del reporte - endDate (query, string) (requerido) — Fecha de fin del reporte - type (query, string) (requerido) — Integration source type

Respuestas: - 200 - 400 — Peticion invalida - 401 — No autorizado - 422 — Entidad no procesable

GET /ad-publishing/facebook/reporting/campaign/{campaignId}

Obtener campaign reporting Retrieve reporting metrics for a specific Facebook campaign

Scopes requeridos: adPublishing.readonly

Parametros: - Versión (header, string) (requerido) — Versión de la API - campaignId (path, string) (requerido) — Identificador de campaña - locationId (query, string) (requerido) — Identificador de sede - startDate (query, string) (requerido) — Fecha de inicio del reporte - endDate (query, string) (requerido) — Fecha de fin del reporte

Respuestas: - 200 - 400 — Peticion invalida - 401 — No autorizado - 422 — Entidad no procesable

GET /ad-publishing/facebook/reporting/list

Obtener reporting list Retrieve a list of Facebook campaigns, adsets, or ads with reporting data

Scopes requeridos: adPublishing.readonly

Parametros: - Versión (header, string) (requerido) — Versión de la API - locationId (query, string) (requerido) — Identificador de sede - listType (query, string) (requerido) — Reporting list type - startDate (query, string) (requerido) — Fecha de inicio del reporte - endDate (query, string) (requerido) — Fecha de fin del reporte - campaignId (query, string) — Campaign identifier (required when listType is adsets or ads) - type (query, string) (requerido) — Integration source type

Respuestas: - 200 - 400 — Peticion invalida - 401 — No autorizado - 422 — Entidad no procesable

GET /ad-publishing/facebook/me

Obtener current Facebook user Retrieve the authenticated Facebook user profile for a location

Scopes requeridos: adPublishing.readonly

Parametros: - Versión (header, string) (requerido) — Versión de la API - locationId (query, string) (requerido) — Identificador de sede - isDraft (query, boolean) — Es borrador

Respuestas: - 200 - 400 — Peticion invalida - 401 — No autorizado - 422 — Entidad no procesable

GET /ad-publishing/facebook/pages

Obtener Facebook pages Retrieve Facebook pages associated with the connected account

Scopes requeridos: adPublishing.readonly

Parametros: - Versión (header, string) (requerido) — Versión de la API - locationId (query, string) (requerido) — Identificador de sede - fetchExisting (query, string) — Fetch existing pages flag

Respuestas: - 200 - 400 — Peticion invalida - 401 — No autorizado - 422 — Entidad no procesable

GET /ad-publishing/facebook/page/{pageId}/instagram

Obtener Instagram accounts for page Retrieve Instagram accounts linked to a specific Facebook page

Scopes requeridos: adPublishing.readonly

Parametros: - Versión (header, string) (requerido) — Versión de la API - pageId (path, string) (requerido) — Identificador de Facebook page - locationId (query, string) (requerido) — Identificador de sede - type (query, string) — Tipo de integración

Respuestas: - 200 - 400 — Peticion invalida - 401 — No autorizado - 422 — Entidad no procesable

GET /ad-publishing/facebook/page/{pageId}/forms

Obtener page lead forms Retrieve lead gen forms for a specific Facebook page

Scopes requeridos: adPublishing.readonly

Parametros: - Versión (header, string) (requerido) — Versión de la API - pageId (path, string) (requerido) — Identificador de Facebook page - locationId (query, string) (requerido) — Identificador de sede - isDraft (query, boolean) — Es borrador

Respuestas: - 200 - 400 — Peticion invalida - 401 — No autorizado - 422 — Entidad no procesable

POST /ad-publishing/facebook/page/{pageId}/forms

Crear page lead form Create a new lead gen form on a Facebook page

Scopes requeridos: adPublishing.write

Parametros: - Versión (header, string) (requerido) — Versión de la API - pageId (path, string) (requerido) — Identificador de Facebook page

Cuerpo de la peticion (application/json): - type (requerido) — string — Lead form type - name (requerido) — string — Lead form name - locationId (requerido) — string — Location identifier - greetingCard — — Greeting card config - questions (requerido) — array — List of questions displayed on the lead form. Required (non-empty) when isDraft is false or omitted; optional for drafts. - label — string — Question label text shown to the user - key (requerido) — string — Question key - type (requerido) — string — Question input type — use a prefilled type for standard fields or CUSTOM / SHORT_ANSWER for freeform questions - options — array — Answer options for multiple-choice questions (only applies to CUSTOM type) - key (requerido) — string — Option key - value (requerido) — string — Option value - questionPageHeadline — string — Question page headline - privacyPolicyLink (requerido) — string — Privacy policy URL. Required when isDraft is false or omitted; optional for drafts. - privacyPolicyText — string — Privacy policy text - customDisclaimer — — Custom disclaimer config - thankYouPage (requerido) — — Thank you page config. Required when isDraft is false or omitted; optional for drafts. - isDraft — boolean — If the form is a draft, set to true - draftFormId — string — Draft form Id - locale — string — Locale

Respuestas: - 201 - 400 — Peticion invalida - 401 — No autorizado - 422 — Entidad no procesable

GET /ad-publishing/facebook/ad-accounts

Obtener ad accounts Retrieve Facebook ad accounts available for the connected user

Scopes requeridos: adPublishing.readonly

Parametros: - Versión (header, string) (requerido) — Versión de la API - locationId (query, string) (requerido) — Identificador de sede - type (query, string) — Account source type - next (query, string) — Pagination cursor - fetchAll (query, string) — Fetch all accounts - limit (query, string) — Results page limit

Respuestas: - 200 - 400 — Peticion invalida - 401 — No autorizado - 422 — Entidad no procesable

GET /ad-publishing/facebook/ad-accounts/{adAccountId}

Obtener ad account details Retrieve details of a specific Facebook ad account

Scopes requeridos: adPublishing.readonly

Parametros: - Versión (header, string) (requerido) — Versión de la API - adAccountId (path, string) (requerido) — Identificador de cuenta publicitaria - locationId (query, string) (requerido) — Identificador de sede - isDraft (query, boolean) — Es borrador

Respuestas: - 200 - 400 — Peticion invalida - 401 — No autorizado - 422 — Entidad no procesable

DELETE /ad-publishing/facebook/ad-accounts/{adAccountId}

Eliminar cuenta publicitaria Remove a Facebook ad account connection from a location

Scopes requeridos: adPublishing.write

Parametros: - Versión (header, string) (requerido) — Versión de la API - adAccountId (path, string) (requerido) — Identificador de cuenta publicitaria

Cuerpo de la peticion (application/json): - locationId (requerido) — string — Location identifier

Respuestas: - 200 - 400 — Peticion invalida - 401 — No autorizado - 422 — Entidad no procesable

GET /ad-publishing/facebook/conversation-forms

Obtener conversation forms Retrieve Facebook conversation lead forms for a location

Scopes requeridos: adPublishing.readonly

Parametros: - Versión (header, string) (requerido) — Versión de la API - locationId (query, string) (requerido) — Identificador de sede - isDraft (query, boolean) — Es borrador

Respuestas: - 200 - 400 — Peticion invalida - 401 — No autorizado - 422 — Entidad no procesable

POST /ad-publishing/facebook/conversation-forms

Crear conversation form Create a new Facebook conversation lead form

Scopes requeridos: adPublishing.write

Parametros: - Versión (header, string) (requerido) — Versión de la API

Cuerpo de la peticion (application/json): - locationId (requerido) — string — Location identifier - name (requerido) — string — Conversation form name - text (requerido) — string — Welcome message text - questions (requerido) — array — Quick-reply questions shown in the welcome message of the conversation form - question (requerido) — string — Question title text - response — string — Auto-response message

Respuestas: - 201 - 400 — Peticion invalida - 401 — No autorizado - 422 — Entidad no procesable

POST /ad-publishing/facebook/integration

Crear Facebook integration Create a Facebook ad integration for a location with page and ad account

Scopes requeridos: adPublishing.write

Parametros: - Versión (header, string) (requerido) — Versión de la API

Cuerpo de la peticion (application/json): - locationId (requerido) — string — Location identifier - pageId (requerido) — string — Facebook page Id - adAccountId — string — Ad account identifier

Respuestas: - 201 - 400 — Peticion invalida - 401 — No autorizado - 422 — Entidad no procesable

GET /ad-publishing/facebook/integration

Obtener Facebook integration Retrieve the Facebook ad integration details for a location

Scopes requeridos: adPublishing.readonly

Parametros: - Versión (header, string) (requerido) — Versión de la API - locationId (query, string) (requerido) — Identificador de sede - isDraft (query, boolean) — Es borrador

Respuestas: - 200 - 400 — Peticion invalida - 401 — No autorizado - 422 — Entidad no procesable

DELETE /ad-publishing/facebook/integration

Eliminar Facebook integration Remove the Facebook ad integration from a location

Scopes requeridos: adPublishing.write

Parametros: - Versión (header, string) (requerido) — Versión de la API

Cuerpo de la peticion (application/json): - locationId (requerido) — string — Location identifier

Respuestas: - 200 - 400 — Peticion invalida - 401 — No autorizado - 422 — Entidad no procesable

GET /ad-publishing/facebook/targeting/search

Buscar targeting options Search Facebook geo-locations and interests for ad targeting

Scopes requeridos: adPublishing.readonly

Parametros: - Versión (header, string) (requerido) — Versión de la API - locationId (query, string) — Identificador de sede - type (query, string) (requerido) — Targeting search type - query (query, string) (requerido) — Search query string - searchType (query, string) — Specific search subtype

Respuestas: - 200 - 400 — Peticion invalida - 401 — No autorizado - 422 — Entidad no procesable

POST /ad-publishing/facebook/campaigns/{campaignId}/publish

Publish campaign Publish a Facebook campaign and push it live to Facebook

Scopes requeridos: adPublishing.write

Parametros: - Versión (header, string) (requerido) — Versión de la API - campaignId (path, string) (requerido) — Identificador de campaña

Cuerpo de la peticion (application/json): - locationId (requerido) — string — Location identifier

Respuestas: - 201 - 400 — Peticion invalida - 401 — No autorizado - 422 — Entidad no procesable

DELETE /ad-publishing/facebook/page

Eliminar page connection Remove a Facebook page connection from a location

Scopes requeridos: adPublishing.write

Parametros: - Versión (header, string) (requerido) — Versión de la API - locationId (query, string) (requerido) — Identificador de sede - pageId (query, string) (requerido) — Id de Facebook page

Respuestas: - 200 - 400 — Peticion invalida - 401 — No autorizado - 422 — Entidad no procesable

GET /ad-publishing/facebook/pixels

Obtener conversion pixels Retrieve Facebook conversion pixels for a location

Scopes requeridos: adPublishing.readonly

Parametros: - Versión (header, string) (requerido) — Versión de la API - locationId (query, string) (requerido) — Identificador de sede - channel (query, string) — Channel type - pageId (query, string) — Id de Facebook page - igUserId (query, string) — Id de Instagram user

Respuestas: - 200 - 400 — Peticion invalida - 401 — No autorizado - 422 — Entidad no procesable

PUT /ad-publishing/facebook/pixels

Crear o actualizar conversion pixel Create or update a Facebook conversion pixel configuration

Scopes requeridos: adPublishing.write

Parametros: - Versión (header, string) (requerido) — Versión de la API

Cuerpo de la peticion (application/json): - locationId (requerido) — string — Location identifier - conversionPixelId — string — Conversion pixel Id - name — string — Pixel name - igUserId — string — Instagram user Id - type (requerido) — string — Pixel event type

Respuestas: - 200 - 400 — Peticion invalida - 401 — No autorizado - 422 — Entidad no procesable

GET /ad-publishing/facebook/custom-audience

Obtener custom audiences Retrieve Facebook custom audiences for a location

Scopes requeridos: adPublishing.readonly

Parametros: - Versión (header, string) (requerido) — Versión de la API - locationId (query, string) (requerido) — Identificador de sede - type (query, string) (requerido) — Audience list type - source (query, string) — Audience data source - adAccountId (query, string) (requerido) — Identificador de cuenta publicitaria

Respuestas: - 200 - 400 — Peticion invalida - 401 — No autorizado - 422 — Entidad no procesable

DELETE /ad-publishing/facebook/custom-audience/{audienceId}

Eliminar custom audience Delete a Facebook custom audience by Id

Scopes requeridos: adPublishing.write

Parametros: - Versión (header, string) (requerido) — Versión de la API - audienceId (path, string) (requerido) — Identificador de Custom audience - locationId (query, string) (requerido) — Identificador de sede - isDraft (query, boolean) — Es borrador

Respuestas: - 200 - 400 — Peticion invalida - 401 — No autorizado - 422 — Entidad no procesable

PUT /ad-publishing/facebook/custom-audience/{audienceId}

Actualizar custom audience Update name or description of a Facebook custom audience

Scopes requeridos: adPublishing.write

Parametros: - Versión (header, string) (requerido) — Versión de la API - audienceId (path, string) (requerido) — Identificador de Custom audience

Cuerpo de la peticion (application/json): - locationId (requerido) — string — Location identifier - name (requerido) — string — Audience name - description — string — Audience description

Respuestas: - 200 - 400 — Peticion invalida - 401 — No autorizado - 422 — Entidad no procesable

GET /ad-publishing/facebook/custom-audience/{audienceId}

Obtener custom audience by Id Retrieve a specific Facebook custom audience by its Id

Scopes requeridos: adPublishing.readonly

Parametros: - Versión (header, string) (requerido) — Versión de la API - audienceId (path, string) (requerido) — Identificador de Custom audience - locationId (query, string) (requerido) — Identificador de sede - isDraft (query, boolean) — Es borrador

Respuestas: - 200 - 400 — Peticion invalida - 401 — No autorizado - 422 — Entidad no procesable

PUT /ad-publishing/facebook/custom-audience/{audienceId}/member

Agregar custom audience member Add a member to a Facebook custom audience

Scopes requeridos: adPublishing.write

Parametros: - Versión (header, string) (requerido) — Versión de la API - audienceId (path, string) (requerido) — Identificador de Custom audience

Cuerpo de la peticion (application/json): - locationId (requerido) — string — Location identifier - contactId (requerido) — string — Contact identifier - fbAdAccountId — string — Facebook ad account Id

Respuestas: - 200 - 400 — Peticion invalida - 401 — No autorizado - 422 — Entidad no procesable

DELETE /ad-publishing/facebook/custom-audience/{audienceId}/member

Quitar custom audience member Remove a member from a Facebook custom audience

Scopes requeridos: adPublishing.write

Parametros: - Versión (header, string) (requerido) — Versión de la API - audienceId (path, string) (requerido) — Identificador de Custom audience

Cuerpo de la peticion (application/json): - locationId (requerido) — string — Location identifier - contactId (requerido) — string — Contact identifier - fbAdAccountId — string — Facebook ad account Id

Respuestas: - 200 - 400 — Peticion invalida - 401 — No autorizado - 422 — Entidad no procesable

PUT /ad-publishing/facebook/custom-audience/{audienceId}/member/batch

Batch update audience members Add or remove members in bulk from a Facebook custom audience via CSV or smart lists

Scopes requeridos: adPublishing.write

Parametros: - Versión (header, string) (requerido) — Versión de la API - audienceId (path, string) (requerido) — Identificador de Custom audience

Cuerpo de la peticion (application/json): - locationId (requerido) — string — Location identifier - csvPath — string — CSV file path - operationType (requerido) — string — Batch operation type - smartlistIds — array — Smartlist IDs array - dynamicAudience — string — Dynamic audience flag

Respuestas: - 200 - 400 — Peticion invalida - 401 — No autorizado - 422 — Entidad no procesable

PUT /ad-publishing/facebook/page/default

Set default page Set the default Facebook page for a location

Scopes requeridos: adPublishing.write

Parametros: - Versión (header, string) (requerido) — Versión de la API - locationId (query, string) (requerido) — Identificador de sede - isDraft (query, boolean) — Es borrador

Cuerpo de la peticion (application/json): - pageId (requerido) — string — Facebook page identifier

Respuestas: - 200 - 400 — Peticion invalida - 401 — No autorizado - 422 — Entidad no procesable

GET /ad-publishing/facebook/lead-form/{leadFormId}

Obtener lead form by Id Retrieve a specific Facebook lead form by its Id

Scopes requeridos: adPublishing.readonly

Parametros: - Versión (header, string) (requerido) — Versión de la API - leadFormId (path, string) (requerido) — Identificador de Lead form - locationId (query, string) (requerido) — Identificador de sede - isDraft (query, boolean) — Es borrador

Respuestas: - 200 - 400 — Peticion invalida - 401 — No autorizado - 422 — Entidad no procesable

GET /ad-publishing/facebook/campaign/{campaignId}

Obtener campaign with linked entities Retrieve a Facebook campaign with its linked adsets and ads

Scopes requeridos: adPublishing.readonly

Parametros: - Versión (header, string) (requerido) — Versión de la API - campaignId (path, string) (requerido) — Identificador de campaña - locationId (query, string) (requerido) — Identificador de sede - fields (query, string) — Comma-separated field names - source (query, string) — Campaign data source

Respuestas: - 200 - 400 — Peticion invalida - 401 — No autorizado - 422 — Entidad no procesable

GET /ad-publishing/facebook/entity

Obtener entities Retrieve Facebook campaigns, adsets, or ads based on entity type

Scopes requeridos: adPublishing.readonly

Parametros: - Versión (header, string) (requerido) — Versión de la API - locationId (query, string) (requerido) — Identificador de sede - type (query, string) (requerido) — Integration source type - next (query, string) — Pagination cursor - fetchAll (query, string) — Fetch all entities - campaignId (query, string) — Identificador de campaña - adSetId (query, string) — Identificador de conjunto de anuncios - entityType (query, string) (requerido) — Entity type to fetch - searchId (query, string) — Identificador de Search - selectedAdAccountId (query, string) — Id de Selected ad account

Respuestas: - 200 - 400 — Peticion invalida - 401 — No autorizado - 422 — Entidad no procesable

PUT /ad-publishing/facebook/campaigns

Crear o actualizar campaña Create or update a Facebook campaign

Scopes requeridos: adPublishing.write

Parametros: - Versión (header, string) (requerido) — Versión de la API

Cuerpo de la peticion (application/json): - id — string — Campaign identifier - locationId (requerido) — string — Location identifier - name — string — Campaign name - objective — string — Campaign objective - specialAdCategories — array — Special ad categories - source — string — Campaign data source

Respuestas: - 200 - 400 — Peticion invalida - 401 — No autorizado - 422 — Entidad no procesable

PUT /ad-publishing/facebook/adsets

Crear o actualizar adset Create or update a Facebook ad set

Scopes requeridos: adPublishing.write

Parametros: - Versión (header, string) (requerido) — Versión de la API

Cuerpo de la peticion (application/json): - id — string — Ad set identifier - locationId (requerido) — string — Location identifier - name — string — Ad set name - pageId — string — Facebook page Id - instagramActorId — string — Instagram actor Id - messagingPlatforms — array — Messaging platforms - whatsappNumber — string — WhatsApp phone number - audience — — Targeting audience configuration including geo-locations, locales, placements, and custom audiences - budget — — Ad set budget config - conversionLocation — string — Conversion location - customEventType — string — Custom event type - pixelId — string — Conversion pixel Id - campaignId (requerido) — string — Parent campaign Id

Respuestas: - 200 - 400 — Peticion invalida - 401 — No autorizado - 422 — Entidad no procesable

PUT /ad-publishing/facebook/ads

Crear o actualizar anuncio Create or update a Facebook ad

Scopes requeridos: adPublishing.write

Parametros: - Versión (header, string) (requerido) — Versión de la API

Cuerpo de la peticion (application/json): - id — string — Ad identifier - locationId (requerido) — string — Location identifier - name — string — Ad name - primaryText — string — Ad primary text - headline — string — Ad headline text - description — string — Ad description text - imageUrl — string — Ad image URL - mediaType — string — Ad media type - media — array — Media items (images or videos) attached to the ad creative - src (requerido) — string — Media source URL - thumbnailUrl — string — Thumbnail URL (required when type is video) - selectedPoster — number — Selected poster index (required when type is video) - type (requerido) — string — Media content type - name — string — Media file name - headline — string — Media headline - description — string — Media description - link — string — Media destination link - multiAdvertiserAds — boolean — Enable multi-advertiser ads - campaignId (requerido) — string — Parent campaign Id - adsetId (requerido) — string — Parent ad set Id - cta — string — Call to action type - conversationFormId — string — Conversation form Id - destinationLink — string — Destination link URL - destinationFormId — string — Destination form Id

Respuestas: - 200 - 400 — Peticion invalida - 401 — No autorizado - 422 — Entidad no procesable

POST /ad-publishing/facebook/campaigns/{campaignId}/pause

Pause campaign Pause a running Facebook campaign

Scopes requeridos: adPublishing.write

Parametros: - Versión (header, string) (requerido) — Versión de la API - campaignId (path, string) (requerido) — Identificador de campaña

Cuerpo de la peticion (application/json): - locationId (requerido) — string — Location identifier

Respuestas: - 201 - 400 — Peticion invalida - 401 — No autorizado - 422 — Entidad no procesable

POST /ad-publishing/facebook/campaigns/{campaignId}/resume

Resume campaign Resume a paused Facebook campaign

Scopes requeridos: adPublishing.write

Parametros: - Versión (header, string) (requerido) — Versión de la API - campaignId (path, string) (requerido) — Identificador de campaña

Cuerpo de la peticion (application/json): - locationId (requerido) — string — Location identifier

Respuestas: - 201 - 400 — Peticion invalida - 401 — No autorizado - 422 — Entidad no procesable

POST /ad-publishing/facebook/campaigns/{campaignId}/duplicate

Duplicar campaña Duplicate an existing Facebook campaign

Scopes requeridos: adPublishing.write

Parametros: - Versión (header, string) (requerido) — Versión de la API - campaignId (path, string) (requerido) — Identificador de campaña

Cuerpo de la peticion (application/json): - locationId (requerido) — string — Location identifier

Respuestas: - 201 - 400 — Peticion invalida - 401 — No autorizado - 422 — Entidad no procesable

DELETE /ad-publishing/facebook/campaigns/{campaignId}

Eliminar campaña Delete a Facebook campaign by Id

Scopes requeridos: adPublishing.write

Parametros: - Versión (header, string) (requerido) — Versión de la API - campaignId (path, string) (requerido) — Identificador de campaña

Cuerpo de la peticion (application/json): - locationId (requerido) — string — Location identifier

Respuestas: - 200 - 400 — Peticion invalida - 401 — No autorizado - 422 — Entidad no procesable

POST /ad-publishing/facebook/adsets/{adSetId}/pause

Pause ad set Pause a running Facebook ad set

Scopes requeridos: adPublishing.write

Parametros: - Versión (header, string) (requerido) — Versión de la API - adSetId (path, string) (requerido) — Identificador de conjunto de anuncios

Cuerpo de la peticion (application/json): - locationId (requerido) — string — Location identifier

Respuestas: - 201 - 400 — Peticion invalida - 401 — No autorizado - 422 — Entidad no procesable

POST /ad-publishing/facebook/adsets/{adSetId}/resume

Resume ad set Resume a paused Facebook ad set

Scopes requeridos: adPublishing.write

Parametros: - Versión (header, string) (requerido) — Versión de la API - adSetId (path, string) (requerido) — Identificador de conjunto de anuncios

Cuerpo de la peticion (application/json): - locationId (requerido) — string — Location identifier

Respuestas: - 201 - 400 — Peticion invalida - 401 — No autorizado - 422 — Entidad no procesable

POST /ad-publishing/facebook/adsets/{adSetId}/duplicate

Duplicar conjunto de anuncios Duplicate an existing Facebook ad set

Scopes requeridos: adPublishing.write

Parametros: - Versión (header, string) (requerido) — Versión de la API - adSetId (path, string) (requerido) — Identificador de conjunto de anuncios

Respuestas: - 201 - 400 — Peticion invalida - 401 — No autorizado - 422 — Entidad no procesable

DELETE /ad-publishing/facebook/adsets/{adSetId}

Eliminar conjunto de anuncios Delete a Facebook ad set by Id

Scopes requeridos: adPublishing.write

Parametros: - Versión (header, string) (requerido) — Versión de la API - adSetId (path, string) (requerido) — Identificador de conjunto de anuncios

Cuerpo de la peticion (application/json): - locationId (requerido) — string — Location identifier

Respuestas: - 200 - 400 — Peticion invalida - 401 — No autorizado - 422 — Entidad no procesable

POST /ad-publishing/facebook/ads/{adId}/pause

Pause ad Pause a running Facebook ad

Scopes requeridos: adPublishing.write

Parametros: - Versión (header, string) (requerido) — Versión de la API - adId (path, string) (requerido) — Identificador de anuncio

Cuerpo de la peticion (application/json): - locationId (requerido) — string — Location identifier

Respuestas: - 201 - 400 — Peticion invalida - 401 — No autorizado - 422 — Entidad no procesable

POST /ad-publishing/facebook/ads/{adId}/resume

Resume ad Resume a paused Facebook ad

Scopes requeridos: adPublishing.write

Parametros: - Versión (header, string) (requerido) — Versión de la API - adId (path, string) (requerido) — Identificador de anuncio

Cuerpo de la peticion (application/json): - locationId (requerido) — string — Location identifier

Respuestas: - 201 - 400 — Peticion invalida - 401 — No autorizado - 422 — Entidad no procesable

POST /ad-publishing/facebook/ads/{adId}/duplicate

Duplicar anuncio Duplicate an existing Facebook ad

Scopes requeridos: adPublishing.write

Parametros: - Versión (header, string) (requerido) — Versión de la API - adId (path, string) (requerido) — Identificador de anuncio

Respuestas: - 201 - 400 — Peticion invalida - 401 — No autorizado - 422 — Entidad no procesable

DELETE /ad-publishing/facebook/ads/{adId}

Eliminar anuncio Delete a Facebook ad by Id

Scopes requeridos: adPublishing.write

Parametros: - Versión (header, string) (requerido) — Versión de la API - adId (path, string) (requerido) — Identificador de anuncio

Cuerpo de la peticion (application/json): - locationId (requerido) — string — Location identifier

Respuestas: - 200 - 400 — Peticion invalida - 401 — No autorizado - 422 — Entidad no procesable

GET /ad-publishing/facebook/campaigns/{campaignId}/publishing-progress

Obtener campaign publishing progress Returns Redis-backed publish progress for a campaign while it is publishing to Meta. Used by the validation funnel UI to poll step counts and completion state.

Scopes requeridos: adPublishing.readonly

Parametros: - Versión (header, string) (requerido) — Versión de la API - campaignId (path, string) (requerido) — Identificador de campaña - locationId (query, string) (requerido) — Identificador de sede - isDraft (query, boolean) — Es borrador

Respuestas: - 200 — Publishing progress for the campaign - 400 — Peticion invalida - 401 — No autorizado - 404 — Campaign not found - 422 — Entidad no procesable

GET /ad-publishing/google/reporting

Obtener reporting data Retrieve aggregated Google Ads reporting metrics for a location

Scopes requeridos: adPublishing.readonly

Parametros: - Versión (header, string) (requerido) — Versión de la API - locationId (query, string) (requerido) — Identificador de sede - fields (query, array) (requerido) — Reporting fields. Pass as comma-separated values on the wire (e.g. ?fields=impressions,clicks). - groupBy (query, string) — Group by period - startDate (query, string) (requerido) — Fecha de inicio del reporte - endDate (query, string) (requerido) — Fecha de fin del reporte - type (query, string) (requerido) — Tipo de integración

Respuestas: - 200 - 400 — Peticion invalida - 401 — No autorizado - 422 — Entidad no procesable

GET /ad-publishing/google/reporting/list

Obtener reporting list Retrieve a list of Google campaigns or ad groups with reporting data

Scopes requeridos: adPublishing.readonly

Parametros: - Versión (header, string) (requerido) — Versión de la API - locationId (query, string) (requerido) — Identificador de sede - listType (query, string) (requerido) — Report list type - startDate (query, string) (requerido) — Fecha de inicio del reporte - endDate (query, string) (requerido) — Fecha de fin del reporte - campaignId (query, string) — Campaign identifier (required when listType is adGroups, ads, or keywords) - type (query, string) (requerido) — Tipo de integración

Respuestas: - 200 - 400 — Peticion invalida - 401 — No autorizado - 422 — Entidad no procesable

GET /ad-publishing/google/reporting/campaign/{campaignId}

Obtener campaign reporting Retrieve reporting metrics for a specific Google campaign

Scopes requeridos: adPublishing.readonly

Parametros: - Versión (header, string) (requerido) — Versión de la API - campaignId (path, string) (requerido) — Identificador de campaña - locationId (query, string) (requerido) — Identificador de sede - startDate (query, string) (requerido) — Fecha de inicio del reporte - endDate (query, string) (requerido) — Fecha de fin del reporte

Respuestas: - 200 - 400 — Peticion invalida - 401 — No autorizado - 422 — Entidad no procesable

GET /ad-publishing/google/conversions

Obtener conversions Retrieve Google Ads conversion actions for a location

Scopes requeridos: adPublishing.readonly

Parametros: - Versión (header, string) (requerido) — Versión de la API - locationId (query, string) (requerido) — Identificador de sede - type (query, string) — Tipo de integración - conversionType (query, string) — Conversion type - category (query, string) — Conversion category - startDate (query, string) — Filter start date - endDate (query, string) — Filter end date

Respuestas: - 200 - 400 — Peticion invalida - 401 — No autorizado - 422 — Entidad no procesable

PUT /ad-publishing/google/conversions

Crear o actualizar conversion Create or update a Google Ads conversion action

Scopes requeridos: adPublishing.write

Parametros: - Versión (header, string) (requerido) — Versión de la API

Cuerpo de la peticion (application/json): - locationId (requerido) — string — Location identifier - conversionId — string — Conversion identifier - name (requerido) — string — Conversion name - type (requerido) — string — Conversion type - category (requerido) — string — Conversion category - valueSettings (requerido) — — Value settings that control how monetary value is attributed to conversions - countingType (requerido) — string — How conversions are counted per interaction - attributionModel (requerido) — string — Attribution model used to credit conversions - clickThroughWindow (requerido) — number — Click-through conversion window in days

Respuestas: - 200 - 400 — Peticion invalida - 401 — No autorizado - 422 — Entidad no procesable

GET /ad-publishing/google/conversions/{conversionId}

Obtener conversion by Id Retrieve a specific Google Ads conversion action by Id

Scopes requeridos: adPublishing.readonly

Parametros: - Versión (header, string) (requerido) — Versión de la API - conversionId (path, string) (requerido) — Identificador de Conversion - locationId (query, string) (requerido) — Identificador de sede - isDraft (query, boolean) — Es borrador

Respuestas: - 200 - 400 — Peticion invalida - 401 — No autorizado - 422 — Entidad no procesable

DELETE /ad-publishing/google/conversions/{conversionId}

Eliminar conversion Delete a Google Ads conversion action by Id

Scopes requeridos: adPublishing.write

Parametros: - Versión (header, string) (requerido) — Versión de la API - conversionId (path, string) (requerido) — Identificador de Conversion - locationId (query, string) (requerido) — Identificador de sede - isDraft (query, boolean) — Es borrador

Respuestas: - 200 - 400 — Peticion invalida - 401 — No autorizado - 422 — Entidad no procesable

GET /ad-publishing/google/integration

Obtener Google integration Retrieve the Google Ads integration details for a location

Scopes requeridos: adPublishing.readonly

Parametros: - Versión (header, string) (requerido) — Versión de la API - locationId (query, string) (requerido) — Identificador de sede - isDraft (query, boolean) — Es borrador

Respuestas: - 200 - 400 — Peticion invalida - 401 — No autorizado - 422 — Entidad no procesable

POST /ad-publishing/google/integration

Crear Google integration Create a Google Ads integration for a location

Scopes requeridos: adPublishing.write

Parametros: - Versión (header, string) (requerido) — Versión de la API

Cuerpo de la peticion (application/json): - locationId (requerido) — string — Location identifier - adAccountId (requerido) — string — Ad account identifier - mccId (requerido) — string — MCC identifier

Respuestas: - 201 - 400 — Peticion invalida - 401 — No autorizado - 422 — Entidad no procesable

GET /ad-publishing/google/me

Obtener current Google user Retrieve the authenticated Google user info for a location

Scopes requeridos: adPublishing.readonly

Parametros: - Versión (header, string) (requerido) — Versión de la API - locationId (query, string) (requerido) — Identificador de sede - isDraft (query, boolean) — Es borrador

Respuestas: - 200 - 400 — Peticion invalida - 401 — No autorizado - 422 — Entidad no procesable

GET /ad-publishing/google/ad-accounts

Obtener Google ad accounts Retrieve Google Ads accounts available for the connected user

Scopes requeridos: adPublishing.readonly

Parametros: - Versión (header, string) (requerido) — Versión de la API - locationId (query, string) (requerido) — Identificador de sede - type (query, string) — Account type

Respuestas: - 200 - 400 — Peticion invalida - 401 — No autorizado - 422 — Entidad no procesable

GET /ad-publishing/google/ad-accounts/{adAccountId}

Obtener ad account details Retrieve details of a specific Google Ads account

Scopes requeridos: adPublishing.readonly

Parametros: - Versión (header, string) (requerido) — Versión de la API - locationId (query, string) (requerido) — Identificador de sede - isDraft (query, boolean) — Es borrador - adAccountId (path, string) (requerido) — Identificador de cuenta publicitaria

Respuestas: - 200 - 400 — Peticion invalida - 401 — No autorizado - 422 — Entidad no procesable

DELETE /ad-publishing/google/ad-accounts/{adAccountId}

Eliminar cuenta publicitaria Remove a Google Ads account connection from a location

Scopes requeridos: adPublishing.write

Parametros: - Versión (header, string) (requerido) — Versión de la API - adAccountId (path, string) (requerido) — Identificador de cuenta publicitaria

Cuerpo de la peticion (application/json): - locationId (requerido) — string — Location identifier

Respuestas: - 200 - 400 — Peticion invalida - 401 — No autorizado - 422 — Entidad no procesable

POST /ad-publishing/google/ads/{adId}/publish

Publish ad Publish a Google ad and push it live

Scopes requeridos: adPublishing.write

Parametros: - Versión (header, string) (requerido) — Versión de la API - adId (path, string) (requerido) — Identificador de anuncio

Respuestas: - 201 - 400 — Peticion invalida - 401 — No autorizado - 422 — Entidad no procesable

GET /ad-publishing/google/targeting/search

Buscar targeting options Search Google geo-locations for ad targeting

Scopes requeridos: adPublishing.readonly

Parametros: - Versión (header, string) (requerido) — Versión de la API - type (query, string) (requerido) — Search type - query (query, string) — Search query - locationId (query, string) (requerido) — Identificador de sede

Respuestas: - 200 - 400 — Peticion invalida - 401 — No autorizado - 422 — Entidad no procesable

POST /ad-publishing/google/keyword-ideas

Obtener keyword ideas Retrieve keyword suggestions for Google Ads campaigns

Scopes requeridos: adPublishing.readonly

Parametros: - Versión (header, string) (requerido) — Versión de la API - locationId (query, string) (requerido) — Identificador de sede - isDraft (query, boolean) — Es borrador

Cuerpo de la peticion (application/json): - url (requerido) — string — Target URL - languageCode — string — Language code - locations — array — Target locations - keywords — array — Seed keywords

Respuestas: - 201 - 400 — Peticion invalida - 401 — No autorizado - 422 — Entidad no procesable

GET /ad-publishing/google/assets

Obtener assets Retrieve Google Ads creative assets for a location

Scopes requeridos: adPublishing.readonly

Parametros: - Versión (header, string) (requerido) — Versión de la API - locationId (query, string) (requerido) — Identificador de sede - type (query, string) (requerido) — Asset type to retrieve - id (query, string) — Identificador de Asset - advertiserOnly (query, string) — Advertiser only flag

Respuestas: - 200 - 400 — Peticion invalida - 401 — No autorizado - 422 — Entidad no procesable

POST /ad-publishing/google/assets

Crear o actualizar assets Create or update Google Ads creative assets

Scopes requeridos: adPublishing.write

Parametros: - Versión (header, string) (requerido) — Versión de la API

Cuerpo de la peticion (application/json): - locationId (requerido) — string — Location identifier - type (requerido) — string — Asset type to create or update - payload (requerido) — — Asset payload — shape depends on the type field: CallAssetPayload (CALL), SitelinkAssetPayload (SITELINK), or LeadFormAssetPayload (LEAD_FORM)

Respuestas: - 201 - 400 — Peticion invalida - 401 — No autorizado - 422 — Entidad no procesable

GET /ad-publishing/google/entity

Obtener entities Retrieve Google campaigns, ad groups, or ads based on entity type

Scopes requeridos: adPublishing.readonly

Parametros: - Versión (header, string) (requerido) — Versión de la API - locationId (query, string) (requerido) — Identificador de sede - type (query, string) (requerido) — Tipo de integración - campaignId (query, string) — Identificador de campaña - adGroupId (query, string) — Identificador de Ad group - entityType (query, string) (requerido) — Entity type - searchId (query, string) — Identificador de Search - startDate (query, string) — Filter start date - endDate (query, string) — Filter end date - selectedAdAccountId (query, string) — Id de Selected ad account

Respuestas: - 200 - 400 — Peticion invalida - 401 — No autorizado - 422 — Entidad no procesable

GET /ad-publishing/google/target-interests

Obtener target interests Retrieve affinity and in-market audience options for Google Ads targeting

Scopes requeridos: adPublishing.readonly

Parametros: - Versión (header, string) (requerido) — Versión de la API - locationId (query, string) (requerido) — Identificador de sede - type (query, string) (requerido) — Interest type - advertisingChannelType (query, string) (requerido) — Channel type

Respuestas: - 200 - 400 — Peticion invalida - 401 — No autorizado - 422 — Entidad no procesable

GET /ad-publishing/google/segments

Obtener segments Retrieve Google Ads audience segments for a location

Scopes requeridos: adPublishing.readonly

Parametros: - Versión (header, string) (requerido) — Versión de la API - locationId (query, string) (requerido) — Identificador de sede - type (query, string) — Segment type

Respuestas: - 200 - 400 — Peticion invalida - 401 — No autorizado - 422 — Entidad no procesable

PUT /ad-publishing/google/segments

Crear o actualizar segment Create or update a Google Ads audience segment

Scopes requeridos: adPublishing.write

Parametros: - Versión (header, string) (requerido) — Versión de la API - locationId (query, string) (requerido) — Identificador de sede - type (query, string) (requerido) — Segment type

Cuerpo de la peticion (application/json): - name (requerido) — string — Segment name - description — string — Segment description - members — array — Segment members — keywords, URLs, or apps that define the custom segment - memberType (requerido) — string — Member type - keyword — string — Keyword value - url — string — URL value - app — string — App identifier - status — string — Segment status - type — string — Segment type - id — string — Segment identifier - membershipStatus — string — Membership status - ruleBasedUserList — — Rule-based user list config - membershipLifeSpan — number — Membership life span - seedUserListIds — array — Seed user list IDs - countryCodes — array — Country codes - expansionLevel — string — Expansion level

Respuestas: - 200 - 400 — Peticion invalida - 401 — No autorizado - 422 — Entidad no procesable

DELETE /ad-publishing/google/segments/{segmentId}

Eliminar segment Delete a Google Ads audience segment by Id

Scopes requeridos: adPublishing.write

Parametros: - Versión (header, string) (requerido) — Versión de la API - segmentId (path, string) (requerido) — Identificador de Segment - locationId (query, string) (requerido) — Identificador de sede - type (query, string) (requerido) — Segment type

Respuestas: - 200 - 400 — Peticion invalida - 401 — No autorizado - 422 — Entidad no procesable

GET /ad-publishing/google/segments/{segmentId}

Obtener segment by Id Retrieve a specific Google Ads audience segment by Id

Scopes requeridos: adPublishing.readonly

Parametros: - Versión (header, string) (requerido) — Versión de la API - segmentId (path, string) (requerido) — Identificador de Segment - locationId (query, string) (requerido) — Identificador de sede - type (query, string) (requerido) — Segment type

Respuestas: - 200 - 400 — Peticion invalida - 401 — No autorizado - 422 — Entidad no procesable

POST /ad-publishing/google/segments/offline-user-list-job

Crear offline user list job Create a job to upload users to a Google customer match list

Scopes requeridos: adPublishing.write

Parametros: - Versión (header, string) (requerido) — Versión de la API

Cuerpo de la peticion (application/json): - locationId (requerido) — string — Location identifier - smartListIds — array — Smart list IDs - csvPath — string — CSV file path - userListId — string — User list identifier - isDynamic — boolean — Dynamic list flag

Respuestas: - 201 - 400 — Peticion invalida - 401 — No autorizado - 422 — Entidad no procesable

PUT /ad-publishing/google/audiences

Crear o actualizar audience Create or update a Google Ads combined audience

Scopes requeridos: adPublishing.write

Parametros: - Versión (header, string) (requerido) — Versión de la API

Cuerpo de la peticion (application/json): - locationId (requerido) — string — Location identifier - resourceName — string — Audience resource name - name (requerido) — string — Audience name - dimensions — — Audience dimensions - exclusionDimension — — Exclusion dimensions

Respuestas: - 200 - 400 — Peticion invalida - 401 — No autorizado - 422 — Entidad no procesable

GET /ad-publishing/google/audiences

Obtener audiences Retrieve Google Ads combined audiences for a location

Scopes requeridos: adPublishing.readonly

Parametros: - Versión (header, string) (requerido) — Versión de la API - locationId (query, string) (requerido) — Identificador de sede - isDraft (query, boolean) — Es borrador

Respuestas: - 200 - 400 — Peticion invalida - 401 — No autorizado - 422 — Entidad no procesable

GET /ad-publishing/google/audiences/{audienceId}

Obtener audience by Id Retrieve a specific Google Ads combined audience by Id

Scopes requeridos: adPublishing.readonly

Parametros: - Versión (header, string) (requerido) — Versión de la API - audienceId (path, string) (requerido) — Identificador de Audience - locationId (query, string) (requerido) — Identificador de sede - isDraft (query, boolean) — Es borrador

Respuestas: - 200 - 400 — Peticion invalida - 401 — No autorizado - 422 — Entidad no procesable

PUT /ad-publishing/google/ads

Crear o actualizar Google campaign Create or update a full Google Ads campaign structure

Scopes requeridos: adPublishing.write

Parametros: - Versión (header, string) (requerido) — Versión de la API

Cuerpo de la peticion (application/json): - id — string — Campaign identifier - name (requerido) — string — Campaign name - locationId (requerido) — string — Location identifier - advertisingChannelType (requerido) — string — Advertising channel - advertisingChannelSubType — string — Channel sub type - goalType — string — Goal type - budget — — Campaign budget - audience — — Campaign audience targeting - networkSettings — — Network settings - biddingStrategy — — Bidding strategy config - assets — — Campaign assets - isEuPoliticalAds — boolean — EU political ads flag - adGroups — array — Campaign ad groups - id — string — Ad group identifier - adGroupId — string — Google ad group identifier - name — string — Ad group name - adCampaignId — string — Ad campaign identifier - adContent — array — Ad content items - id — string — Ad identifier - name — string — Ad name - mediaType — string — Media type - headlines — array — Ad headlines - longHeadlines — array — Long headlines - descriptions — array — Ad descriptions - finalUrl — string — Final URL - path1 — string — Display path 1 - path2 — string — Display path 2 - isDeleted — boolean — Whether the ad is soft-deleted - adError — string — Ad-level error message from Google - publishingStatus — string — Ad publishing status - adId — string — Internal ad identifier - adCampaignId — string — Ad campaign identifier - adGroupId — string — Ad group identifier - googleAdId — string — Google Ads ad resource Id - media — array — Ad media items - type — string — Media type - src — string — Media source URL - isLogo — boolean — Is logo flag - error — string — Error message if media failed - url — string — Public URL of the media - imageType — string — Image type classification - callToActionLabel — string — Call to action label - businessName — string — Business name - youtubeVideoLinks — array — YouTube video links - youtubeVideoId (requerido) — string — YouTube video Id - carouselCards — array — Carousel cards - headline — string — Card headline - finalUrl — string — Card final URL - callToActionLabel — string — Call to action label - media — array — Card media items - type — string — Media type - src — string — Media source URL - isLogo — boolean — Is logo flag - error — string — Error message if media failed - url — string — Public URL of the media - imageType — string — Image type classification - placements — array — Channel placements - customChannels — boolean — Custom channels flag - keywords — — Keyword targeting - publishingStatus — string — Ad group publishing status - adGroupError — string — Ad group-level error from Google - googleAdGroupId — string — Google Ads ad group resource Id - customChannels — boolean — Custom channels flag - selectedChannels — array — Selected channel placements - googleAudienceId — string — Google audience resource Id - audience — — Ad group audience targeting - campaignGoal — — Campaign goal config - adSchedule — array — Ad schedule rules - dayOfWeek (requerido) — string — Day of week - from (requerido) — string — Start time (HH:MM) - to (requerido) — string — End time (HH:MM) - publishingStatus — string — Publishing status - googleAdAccountId — string — Google Ad account identifier - unpublishedChanges — boolean — Whether the campaign has unpublished changes - maximumCpc — number — Maximum CPC bid in micros - googleCampaignId — string — Google Ads campaign resource Id - source — string — Traffic source - advancedOptions — object — Advanced options

Respuestas: - 200 - 400 — Peticion invalida - 401 — No autorizado - 422 — Entidad no procesable

GET /ad-publishing/google/ads/{adId}

Obtener Google campaign by Id Retrieve a specific Google Ads campaign by Id

Scopes requeridos: adPublishing.readonly

Parametros: - Versión (header, string) (requerido) — Versión de la API - adId (path, string) (requerido) — Identificador de anuncio - locationId (query, string) (requerido) — Identificador de sede - isDraft (query, boolean) — Es borrador

Respuestas: - 200 - 400 — Peticion invalida - 401 — No autorizado - 422 — Entidad no procesable

GET /ad-publishing/google/conversion-goals

Obtener conversion goals Retrieve Google Ads conversion goals for a location

Scopes requeridos: adPublishing.readonly

Parametros: - Versión (header, string) (requerido) — Versión de la API - locationId (query, string) (requerido) — Identificador de sede - isDraft (query, boolean) — Es borrador

Respuestas: - 200 - 400 — Peticion invalida - 401 — No autorizado - 422 — Entidad no procesable

GET /ad-publishing/linkedin/integration

Obtener LinkedIn integration Retrieve the LinkedIn Ads integration details for a location

Scopes requeridos: adPublishing.readonly

Parametros: - Versión (header, string) (requerido) — Versión de la API - locationId (query, string) (requerido) — Identificador de sede - isDraft (query, boolean) — Es borrador

Respuestas: - 200 - 400 — Peticion invalida - 401 — No autorizado - 422 — Entidad no procesable

POST /ad-publishing/linkedin/integration

Crear LinkedIn integration Create a LinkedIn Ads integration for a location with ad account details

Scopes requeridos: adPublishing.write

Parametros: - Versión (header, string) (requerido) — Versión de la API

Cuerpo de la peticion (application/json): - locationId (requerido) — string — Location identifier - adAccountId (requerido) — string — Ad account identifier - adAccountName (requerido) — string — Ad account name - currencyCode (requerido) — string — Currency code - organizationId (requerido) — string — Organization identifier

Respuestas: - 201 - 400 — Peticion invalida - 401 — No autorizado - 422 — Entidad no procesable

GET /ad-publishing/linkedin/ad-accounts

Obtener LinkedIn ad accounts Retrieve LinkedIn Ads accounts available for the connected user

Scopes requeridos: adPublishing.readonly

Parametros: - Versión (header, string) (requerido) — Versión de la API - locationId (query, string) (requerido) — Identificador de sede - isDraft (query, boolean) — Es borrador

Respuestas: - 200 - 400 — Peticion invalida - 401 — No autorizado - 422 — Entidad no procesable

GET /ad-publishing/linkedin/ad-account

Obtener ad account details Retrieve details of a specific LinkedIn ad account

Scopes requeridos: adPublishing.readonly

Parametros: - Versión (header, string) (requerido) — Versión de la API - locationId (query, string) (requerido) — Identificador de sede - adAccountId (query, string) (requerido) — Identificador de cuenta publicitaria

Respuestas: - 200 - 400 — Peticion invalida - 401 — No autorizado - 422 — Entidad no procesable

DELETE /ad-publishing/linkedin/ad-account

Eliminar cuenta publicitaria Remove a LinkedIn ad account connection from a location

Scopes requeridos: adPublishing.write

Parametros: - Versión (header, string) (requerido) — Versión de la API - locationId (query, string) (requerido) — Identificador de sede - adAccountId (query, string) (requerido) — Identificador de cuenta publicitaria

Respuestas: - 200 - 400 — Peticion invalida - 401 — No autorizado - 422 — Entidad no procesable

GET /ad-publishing/linkedin/me

Obtener current LinkedIn user Retrieve the authenticated LinkedIn user info for a location

Scopes requeridos: adPublishing.readonly

Parametros: - Versión (header, string) (requerido) — Versión de la API - locationId (query, string) (requerido) — Identificador de sede - isDraft (query, boolean) — Es borrador

Respuestas: - 200 - 400 — Peticion invalida - 401 — No autorizado - 422 — Entidad no procesable

GET /ad-publishing/linkedin/ads/{adId}

Obtener ad campaign group Retrieve a LinkedIn ad campaign group by Id

Scopes requeridos: adPublishing.readonly

Parametros: - Versión (header, string) (requerido) — Versión de la API - adId (path, string) (requerido) — Identificador de anuncio - locationId (query, string) (requerido) — Identificador de sede - isDraft (query, boolean) — Es borrador

Respuestas: - 200 - 400 — Peticion invalida - 401 — No autorizado - 422 — Entidad no procesable

POST /ad-publishing/linkedin/ads/{adId}/publish

Publish ad campaign group Publish a LinkedIn ad campaign group and push it live

Scopes requeridos: adPublishing.write

Parametros: - Versión (header, string) (requerido) — Versión de la API - adId (path, string) (requerido) — Identificador de anuncio

Cuerpo de la peticion (application/json): - locationId (requerido) — string — Location identifier

Respuestas: - 201 - 400 — Peticion invalida - 401 — No autorizado - 422 — Entidad no procesable

PUT /ad-publishing/linkedin/ads

Crear o actualizar ad campaign group Create or update a LinkedIn ad campaign group with campaigns and ads

Scopes requeridos: adPublishing.write

Parametros: - Versión (header, string) (requerido) — Versión de la API

Cuerpo de la peticion (application/json): - id — string — Internal Id - locationId (requerido) — string — Location Id - budget — — Campaign group budget - adCampaigns — array — Child ad campaigns - id — string — Internal campaign identifier - locale — — Campaign locale - name — string — Campaign name - publishingStatus — string — Publishing status - mediaType — string — Creative media type for the campaign - audience — — Campaign audience targeting - unitCost — — Bid unit cost - campaignType — string — LinkedIn campaign type - adCampaignGroupId — string — Parent campaign group identifier - adCampaignId — string — LinkedIn campaign resource Id - ads — array — Ads in the campaign - id — string — Ad identifier - name — string — Ad name - introductoryText — string — Introductory ad copy shown above the creative - destinationUrl — string — Click-through destination URL - callToActionLabel — string — Call to action label - destinationFormId — string — Destination lead-gen form Id - contentReferenceString — string — Content reference URN for boosted posts - media — array — Ad creative media - type — string — Media type - src — string — Media source URL - frames — array — Video frame URLs - selectedPoster — number — Selected poster frame index - thumbnailUrl — string — Thumbnail URL - name — string — Media name - headline — string — Media headline - destinationUrl — string — Click-through destination URL - fileSizeBytes — number — File size in bytes - adCampaignId — string — Parent ad campaign identifier - adId — string — LinkedIn ad resource Id - headline — string — Ad headline - publishingStatus — string — Ad publishing status - adCampaignGroupId — string — Parent campaign group identifier - description — string — Ad description - meta — object — Additional ad metadata - linkedInError — string — LinkedIn API error message - linkedInError — string — LinkedIn API error message - meta — object — Additional campaign metadata - adBudgetOptimization — string — Ad budget optimization mode - objectiveType — string — Campaign group objective - name — string — Campaign group name - adCampaignGroupId — string — LinkedIn campaign group resource Id - publishingStatus — string — Publishing status - linkedInAdAccountId — string — LinkedIn ad account identifier - unpublishedChanges — boolean — Whether the campaign group has unpublished changes - meta — object — Additional metadata - linkedInError — string — LinkedIn API error message

Respuestas: - 200 - 400 — Peticion invalida - 401 — No autorizado - 422 — Entidad no procesable

GET /ad-publishing/linkedin/targeting/search

Buscar targeting options Search LinkedIn targeting facets such as locations, industries, and job titles

Scopes requeridos: adPublishing.readonly

Parametros: - Versión (header, string) (requerido) — Versión de la API - locationId (query, string) (requerido) — Identificador de sede - facet (query, string) (requerido) — Targeting facet - query (query, string) — Search query - q (query, string) — Query parameter

Respuestas: - 200 - 400 — Peticion invalida - 401 — No autorizado - 422 — Entidad no procesable

GET /ad-publishing/linkedin/{accountId}/forms

Obtener lead forms Retrieve LinkedIn lead gen forms for an ad account

Scopes requeridos: adPublishing.readonly

Parametros: - Versión (header, string) (requerido) — Versión de la API - accountId (path, string) (requerido) — Identificador de cuenta - locationId (query, string) (requerido) — Identificador de sede - isDraft (query, boolean) — Es borrador

Respuestas: - 200 - 400 — Peticion invalida - 401 — No autorizado - 422 — Entidad no procesable

POST /ad-publishing/linkedin/{accountId}/form

Crear lead form Create a new LinkedIn lead gen form for an ad account

Scopes requeridos: adPublishing.write

Parametros: - Versión (header, string) (requerido) — Versión de la API - locationId (query, string) (requerido) — Identificador de sede - isDraft (query, boolean) — Es borrador

Cuerpo de la peticion (application/json): - owner (requerido) — — Form owner - creationLocale (requerido) — — Creation locale - name (requerido) — string — Form name - state (requerido) — string — Form state - content (requerido) — — Form content - hiddenFields — array — Hidden fields - name (requerido) — string — Field name - value (requerido) — string — Field value

Respuestas: - 201 - 400 — Peticion invalida - 401 — No autorizado - 422 — Entidad no procesable

PATCH /ad-publishing/linkedin/{adId}/status

Actualizar ad status Pause or resume a LinkedIn ad, campaign, or ad group

Scopes requeridos: adPublishing.write

Parametros: - Versión (header, string) (requerido) — Versión de la API - adId (path, string) (requerido) — Identificador de anuncio - locationId (query, string) (requerido) — Identificador de sede - isDraft (query, boolean) — Es borrador

Cuerpo de la peticion (application/json): - operationType (requerido) — string — Update operation - type (requerido) — string — Ad object type

Respuestas: - 200 - 400 — Peticion invalida - 401 — No autorizado - 422 — Entidad no procesable

GET /ad-publishing/linkedin/reporting

Obtener ad analytics Retrieve LinkedIn Ads analytics data with configurable pivot and time grouping

Scopes requeridos: adPublishing.readonly

Parametros: - Versión (header, string) (requerido) — Versión de la API - locationId (query, string) (requerido) — Id de sede - pivot (query, string) — Analytics pivot type - groupBy (query, string) — Time granularity for analytics - startDate (query, string) (requerido) — Start date in yyyy-mm-dd format - endDate (query, string) (requerido) — End date in yyyy-mm-dd format - entityUrns (query, string) — Comma-separated list of entity URNs - fields (query, array) — Reporting fields. Pass as comma-separated values on the wire (e.g. ?fields=impressions,clicks).

Respuestas: - 200 - 400 — Peticion invalida - 401 — No autorizado - 422 — Entidad no procesable

GET /ad-publishing/linkedin/reporting/list

Obtener reporting list Retrieve a list of LinkedIn campaigns or campaign groups with reporting data

Scopes requeridos: adPublishing.readonly

Parametros: - Versión (header, string) (requerido) — Versión de la API - locationId (query, string) (requerido) — Id de sede - listType (query, string) (requerido) — List type - campaignId (query, string) (requerido) — Id de campaña - campaignGroupId (query, string) (requerido) — Id de Campaign group - startDate (query, string) (requerido) — Start date in yyyy-mm-dd format - endDate (query, string) (requerido) — End date in yyyy-mm-dd format - fields (query, array) — Reporting fields. Pass as comma-separated values on the wire (e.g. ?fields=impressions,clicks).

Respuestas: - 200 - 400 — Peticion invalida - 401 — No autorizado - 422 — Entidad no procesable

GET /ad-publishing/linkedin/reporting/campaign-group/{campaignGroupId}

Obtener campaign group reporting Retrieve reporting metrics for a specific LinkedIn campaign group

Scopes requeridos: adPublishing.readonly

Parametros: - Versión (header, string) (requerido) — Versión de la API - campaignGroupId (path, string) (requerido) — Identificador de Campaign group - locationId (query, string) (requerido) — Id de sede - startDate (query, string) (requerido) — Start date in yyyy-mm-dd format - endDate (query, string) (requerido) — End date in yyyy-mm-dd format - fields (query, array) — Reporting fields. Pass as comma-separated values on the wire (e.g. ?fields=impressions,clicks). - campaignGroupId (query, string) — Id de Campaign group

Respuestas: - 200 - 400 — Peticion invalida - 401 — No autorizado - 422 — Entidad no procesable

Enter para abrir el primer resultado · Esc para cerrar