Linkedin Ads

Parámetros de entrada

• namestringObligatorio

  A label for the account (required)

• testboolean

  Flag showing whether this account is marked as a test account. An account can be marked as test only during creation. This is an immutable field. Test accounts are useful for development and demos - ads are not served and not billed.

• typestringObligatorioenum

  Account type. BUSINESS is the only value allowed when creating accounts through the API. ENTERPRISE is reserved for accounts created by LinkedIn's internal systems.

  BUSINESSENTERPRISE
• currencystring

  The 3 character standard currency code such as USD for United States Dollar. Default is USD.

• referencestringObligatorio

  The entity URN on whose behalf the account is advertised. Must be in the format urn:li:person:{id} or urn:li:organization:{id}

• notifiedOnEndOfCampaignboolean

  Indicates if the campaign contact is notified when an associated campaign has been completed

• notifiedOnCreativeApprovalboolean

  Indicates if the creative contact is notified when a creative has been reviewed and approved

• notifiedOnCreativeRejectionboolean

  Indicates if the creative contact is notified when a creative has been rejected due to content

• notifiedOnNewFeaturesEnabledboolean

  Indicates if the account owner is notified about new Campaign Manager features

• notifiedOnCampaignOptimizationboolean

  Indicates if the campaign contact is notified about campaign optimization opportunities

Parámetros de salida

• dataobjectObligatorio

  Data from the action execution

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• namestringObligatorio

  Name of the lead form for internal tracking

• ownerobjectObligatorio

  Owner of the form (either sponsoredAccount or organization)

• statestringObligatorioenum

  Initial state of the form

  DRAFTPUBLISHEDARCHIVED
• contentobjectObligatorio

  Form content displayed to viewers

• hiddenFieldsobject[]

  Hidden tracking fields (max 20 fields)

• creationLocaleobjectObligatorio

  Locale for the form

Parámetros de salida

• dataobjectObligatorio

  Data from the action execution

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• ad_account_idintegerObligatorio

  The unique LinkedIn Ad Account ID to retrieve

Parámetros de salida

• dataobjectObligatorio

  Data from the action execution

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• qstringenum

  Query type - use 'analytics' for single pivot grouping

  analyticsstatistics
• pivotstringenum

  Pivot dimension for grouping analytics results.

  ACCOUNTCAMPAIGNCAMPAIGN_GROUPCREATIVECOMPANYSHARECONVERSIONSERVING_LOCATIONCARD_INDEXMEMBER_COMPANY_SIZEMEMBER_INDUSTRYMEMBER_SENIORITY+8
• fieldsstring

  Comma-separated list of metric fields to retrieve. If not specified, only impressions and clicks are returned. Example: 'impressions,clicks,costInLocalCurrency,landingPageClicks'

• accountsstring[]

  List of account URNs to filter by (e.g., ['urn:li:sponsoredAccount:525410360'])

• campaignsstring[]

  List of campaign URNs to filter by (e.g., ['urn:li:sponsoredCampaign:1234567'])

• creativesstring[]

  List of creative URNs to filter by

• dateRangeobjectObligatorio

  Date range for analytics data. Start date is required, end date is optional

• campaignGroupsstring[]

  List of campaign group URNs to filter by

• timeGranularitystringenum

  Time granularity for analytics results.

  ALLDAILYMONTHLYYEARLY

Parámetros de salida

• dataobjectObligatorio

  Data from the action execution

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• targeting_criteriastringObligatorio

  Targeting criteria string in LinkedIn's encoded format. Must be a URL-encoded string following the pattern: (include:(and:List((or:(urn%3Ali%3AadTargetingFacet%3A{facet_type}:List({encoded_values})))))) Example for location and skills targeting: (include:(and:List((or:(urn%3Ali%3AadTargetingFacet%3Alocations:List(urn%3Ali%3Ageo%3A102221843))),(or:(urn%3Ali%3AadTargetingFacet%3Askills:List(urn%3Ali%3Askill%3A17)))))) Common facet types: locations (urn:li:geo:ID), skills (urn:li:skill:ID), industries (urn:li:industry:ID), jobFunctions (urn:li:function:ID), seniorities (urn:li:seniority:ID). URNs must be URL-encoded (colons as %3A). Supports include/exclude logic with and/or operators.

Parámetros de salida

• dataobjectObligatorio

  Data from the action execution

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• ad_account_idstringObligatorio

  The LinkedIn ad account ID

• ad_campaign_group_idstringObligatorio

  The campaign group ID to retrieve

Parámetros de salida

• dataobjectObligatorio

  Data from the action execution

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• form_idintegerObligatorio

  The unique identifier of the LinkedIn lead form to retrieve.

Parámetros de salida

• dataobjectObligatorio

  Data from the action execution

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• edge_typestringenum

  Edge type for the network size query. Use COMPANY_FOLLOWED_BY_MEMBER to get follower count.

  COMPANY_FOLLOWED_BY_MEMBER
• organization_urnstringObligatorio

  Organization URN in format 'urn:li:organization:{id}'. Example: 'urn:li:organization:1337'

Parámetros de salida

• dataobjectObligatorio

  Data from the action execution

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• qstringObligatorioenum

  Query type for the search. Use 'organization' to find ACLs for a specific organization, or 'roleAssignee' to find all organizations where the authenticated user has access control roles.

  organizationroleAssignee
• rolestringenum

  Organization role types that define access privileges.

  ADMINISTRATORDIRECT_SPONSORED_CONTENT_POSTERRECRUITING_POSTERLEAD_CAPTURE_ADMINISTRATORLEAD_GEN_FORMS_MANAGERANALYSTCURATORCONTENT_ADMINISTRATOR
• countinteger

  Maximum number of results to return per page. Default is 10.

• startinteger

  Starting index for pagination. Default is 0.

• statestringenum

  Role state values.

  APPROVEDREJECTEDREQUESTEDREVOKED
• organizationstring

  Organization URN to filter results. Required when q='organization'. Must be in the format 'urn:li:organization:{id}'.

Parámetros de salida

• dataobjectObligatorio

  Data from the action execution

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• organizationstringObligatorio

  Organization URN in the format urn:li:organization:{id}. You can get the organization ID from the LinkedIn page URL.

• timeIntervalsobject

  Time intervals configuration for statistics.

Parámetros de salida

• dataobjectObligatorio

  Data from the action execution

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• timeIntervalsobject

  Time intervals configuration for statistics.

• organizationalEntitystringObligatorio

  The organization identifier in URN format (e.g., urn:li:organization:1234).

Parámetros de salida

• dataobjectObligatorio

  Data from the action execution

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• sharesstring[]

  Filter results to specific share URNs. When specified, returns statistics for individual shares. Time-bound statistics are not supported when filtering by shares. Each share URN must be of the format 'urn:li:share:{id}'.

• ugcPostsstring[]

  Filter results to specific UGC Post URNs. When specified, returns statistics for individual posts. Time-bound statistics are not supported when filtering by UGC posts. Each UGC Post URN must be of the format 'urn:li:ugcPost:{id}'.

• timeIntervalsobject

  Time intervals configuration for time-bound statistics.

• organizationalEntitystringObligatorio

  The organization identifier URN. Must be of the format 'urn:li:organization:{id}' or 'urn:li:organizationBrand:{id}'.

Parámetros de salida

• dataobjectObligatorio

  Data from the action execution

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• accountstringObligatorio

  The sponsored account URN for which the supply forecast is requested

• costCapstring

  Cost cap as decimal string. Required only for optimization target type of cost cap

• campaignstring

  The sponsored campaign URN if available, used to provide better forecasts

• timeRangeobjectObligatorio

  The time range for the forecast with start and end timestamps

• targetCoststring

  Target cost as decimal string. Required only for optimization target type of target cost

• dailyBudgetobject

  Represents a monetary amount with currency.

• totalBudgetobject

  Represents a monetary amount with currency.

• campaignTypestringObligatorioenum

  The campaign type. For connected television campaigns, must be SPONSORED_UPDATES

  SPONSORED_UPDATESSPONSORED_INMAILSDYNAMIC
• competingBidobject

  Bid configuration for manual bidding.

• creativeTypestring

  Creative type if available, used to provide better forecasts

• objectiveTypestring

  Campaign objective type if available, used to provide better forecasts. Examples: BRAND_AWARENESS, WEBSITE_VISITS, ENGAGEMENT, VIDEO_VIEWS, LEAD_GENERATION, WEBSITE_CONVERSIONS, JOB_APPLICANTS

• targetingCriteriastringObligatorio

  URL-encoded targeting criteria string in RestLi format. Specifies boolean expression (AND/OR) for including/excluding targeting facets. Example: (include:(and:List((or:(urn%3Ali%3AadTargetingFacet%3Alocations:List(urn%3Ali%3Ageo%3A103644278))))))

• optimizationTargetstringenum

  Valid optimization target types for LinkedIn Ads.

  NONELEAD_GENERATIONLANDING_PAGE_CLICKSVIDEO_VIEWENGAGEMENTCONVERSIONS
• enableAudienceNetworkboolean

  Include LinkedIn Audience Network inventory into campaign performance forecast. Must be true for connected television campaigns

• connectedTelevisionOnlyboolean

  Generate forecasting for connected television campaigns. Applicable only from version 202408 and above

• enableAudienceExpansionboolean

  Include Audience Expansion inventory into campaign performance forecast

Parámetros de salida

• dataobjectObligatorio

  Data from the action execution

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• qstringObligatorioenum

  Query type to use. 'adTargetingFacet' returns all entities for a facet, 'typeahead' searches entities by query text, 'urns' retrieves entities by URNs, 'similarEntities' finds similar entities.

  adTargetingFacettypeaheadurnssimilarEntities
• urnsstring[]

  List of URNs to retrieve metadata for. Required when q='urns'. Example: ['urn:li:fieldOfStudy:100990', 'urn:li:organization:1035']

• facetstring

  Facet URN to query (e.g., 'urn:li:adTargetingFacet:locations', 'urn:li:adTargetingFacet:industries'). Required for adTargetingFacet, typeahead, and similarEntities query types.

• querystring

  Search query text for typeahead searches. Required when q='typeahead'. Partial text used for matching targeting entities.

• entitiesstring[]

  List of entity URNs to find similar entities for. Required when q='similarEntities'. Example: ['urn:li:organization:1003']

• queryVersionstring

  Query version to use. Use 'QUERY_USES_URNS' for URN-based queries. Defaults to 'QUERY_USES_URNS' when not specified.

• locale_countrystring

  Uppercase two-letter country code as defined by ISO-3166 (e.g., 'US', 'GB', 'CA'). Used for localized entity names. Defaults to 'US' if not provided.

• locale_languagestring

  Lowercase two-letter language code as defined by ISO-639 (e.g., 'en', 'fr', 'es'). Used for localized entity names. Defaults to 'en' if not provided.

Parámetros de salida

• dataobjectObligatorio

  Data from the action execution

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

Sin parámetros.

Parámetros de salida

• dataobjectObligatorio

  Data from the action execution

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• accountstringObligatorio

  Sponsored account URN in the format 'urn:li:sponsoredAccount:{accountId}'. This identifies the ad account whose conversion rules you want to retrieve.

Parámetros de salida

• dataobjectObligatorio

  Data from the action execution

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• qstring

  Query type for filtering segments. Use "account" to find segments by account.

• idsinteger[]

  List of segment IDs to retrieve specific segments

• countinteger

  Number of results per page for pagination when using q=account (max 100)

• startinteger

  Starting index for pagination when using q=account

• accountstring

  Sponsored account URN to filter segments by. Format: urn:li:sponsoredAccount:{id}

Parámetros de salida

• dataobjectObligatorio

  Data from the action execution

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• qstring

  Query type. Set to 'owner' to find forms by owner. Required when using owner parameter.

• idsinteger[]

  List of lead form IDs to retrieve specific forms

• countinteger

  Number of results to display per page. Used with q=owner for pagination.

• startinteger

  Index of the form to begin results at. Indexes start at 0. Used with q=owner for pagination.

• owner_organizationstring

  Organization URN to filter lead forms (e.g., urn:li:organization:123456). Use with q=owner.

• owner_sponsored_accountstring

  Sponsored Account URN to filter lead forms (e.g., urn:li:sponsoredAccount:123456). Use with q=owner.

Parámetros de salida

• dataobjectObligatorio

  Data from the action execution

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• qstringenum

  Query type for organization lookup.

  vanityNameparentOrganization
• idsinteger[]

  List of organization IDs to retrieve. Use this to batch lookup multiple organizations by their numeric IDs.

• parentstring

  Parent organization URN. Required when q=parentOrganization. Format: urn:li:organization:{id}

• vanityNamestring

  Vanity name to look up. Required when q=vanityName. Example: 'linkedin' for LinkedIn company page.

Parámetros de salida

• dataobjectObligatorio

  Data from the action execution

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• qstringenum

  Query type for listing posts.

  authordscAdAccount
• idsstring[]

  List of post URNs to retrieve specific posts. Format: 'urn:li:share:{id}' or 'urn:li:ugcPost:{id}'. Example: ['urn:li:share:6844785523593134080', 'urn:li:ugcPost:7428263313739988992']. Use this to retrieve multiple specific posts by their URNs.

• countinteger

  Number of results to return per page. Default is 10, maximum is 100.

• startinteger

  The index of the first item for pagination. Default is 0.

• authorstring

  Person or Organization URN to filter posts by author. Format: 'urn:li:person:{id}' or 'urn:li:organization:{id}'. Example: 'urn:li:organization:2414183'. Required when q='author'.

• sortBystringenum

  Sort field for posts.

  LAST_MODIFIEDCREATED
• linkedin_versionstring

  LinkedIn API version in YYYYMM format. Defaults to 202602.

Parámetros de salida

• dataobjectObligatorio

  Data from the action execution

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• idsinteger[]Obligatorio

  List of organization IDs to retrieve. Each ID should be a numeric organization identifier (e.g., [90966477, 79988552]). Does not require admin access to these organizations.

• linkedin_versionstring

  LinkedIn API version in YYYYMM format. Defaults to 202601.

Parámetros de salida

• dataobjectObligatorio

  Data from the action execution

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• ownerstringObligatorio

  URN of the owner entity (e.g., person or organization URN like 'urn:li:person:a4I-u208D9' or 'urn:li:organization:12345')

• recipesstring[]Obligatorio

  List of recipe URNs that define how the asset will be processed (e.g., 'urn:li:digitalmediaRecipe:feedshare-image' for images, 'urn:li:digitalmediaRecipe:feedshare-video' for videos)

• serviceRelationshipsobject[]Obligatorio

  List of service relationships defining ownership and permissions

• supportedUploadMechanismstring[]Obligatorio

  List of upload mechanisms to use. SYNCHRONOUS_UPLOAD for direct upload, MULTIPART_UPLOAD for large files

Parámetros de salida

• dataobjectObligatorio

  Data from the action execution

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• idinteger[]

  Filter accounts by ID. Can include multiple IDs.

• namestring[]

  Filter accounts by name. Can include multiple names.

• testboolean

  Filter by test or non-test accounts. Set to true for test accounts, false for non-test accounts. If omitted, returns both.

• typestring[]

  Filter accounts by type: BUSINESS or ENTERPRISE.

• statusstring[]

  Filter accounts by status. Can include multiple values: ACTIVE, DRAFT, CANCELED, PENDING_DELETION, or REMOVED.

• page_sizeinteger

  Number of entities to return per page. Maximum is 1000.

• referencestring[]

  Filter accounts by reference URN (e.g., 'urn:li:organization:2414183' or 'urn:li:person:12345').

• page_tokenstring

  Token for pagination to fetch the next set of results. Use the nextPageToken from the previous response.

• sort_fieldstringenum

  Enum for sort field values.

  ID
• sort_orderstringenum

  Enum for sort order values.

  ASCENDINGDESCENDING

Parámetros de salida

• dataobjectObligatorio

  Data from the action execution

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• qstring

  Query type (typically 'search' for campaign searches)

• idsstring

  Comma-separated list of campaign IDs to retrieve

• searchstring

  Search criteria as JSON string with status, type, or test filters. Example: '(status:(values:List(ACTIVE)))'

• pageSizeinteger

  Number of entities to return (max: 1000, default: 100)

• pageTokenstring

  Pagination token for fetching next page of results

• sortOrderstring

  Sort order (ASCENDING or DESCENDING) - sorted by campaign ID

• adAccountIdintegerObligatorio

  Ad Account ID to search campaigns in

Parámetros de salida

• dataobjectObligatorio

  Data from the action execution

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• campaignsstring[]

  Filter creatives by campaign URN(s). Provide a list of sponsored campaign URNs (e.g., 'urn:li:sponsoredCampaign:360035215'). Multiple campaigns are ORed together.

• creativesstring[]

  Filter by specific creative URN(s). Provide a list of sponsored creative URNs (e.g., 'urn:li:sponsoredCreative:119962155'). Multiple creatives are ORed together.

• page_sizeinteger

  Number of creatives to return per page (default: 100, max: 100). Use for pagination control.

• page_tokenstring

  Pagination cursor token from the previous response's nextPageToken field. Use to fetch the next page of results. Omit for the first page.

• sort_orderstringenum

  Sort order for creative results.

  ASCENDINGDESCENDING
• ad_account_idstringObligatorio

  LinkedIn Ad Account ID (numeric ID without URN prefix, e.g., '520376796'). Required to identify which ad account to search creatives in.

• is_test_accountboolean

  Filter by test account status. True returns only creatives under test accounts, False returns only non-test accounts, null/omitted returns all regardless of test status.

• intended_statusesstring[]

  Filter creatives by intended status. Multiple statuses are ORed together. Values: ACTIVE (creative available for serving), PAUSED (temporarily not served), DRAFT (incomplete), ARCHIVED (not served, separated from active), CANCELED (hidden from queries), PENDING_DELETION (deletion in progress), REMOVED (deleted but fetchable).

• content_referencesstring[]

  Filter creatives by content reference URN(s). Can be share URN or ugcPost URN (e.g., 'urn:li:share:6778045555198214144', 'urn:li:ugcPost:6778045555198214144'). Multiple references are ORed together.

• leadgen_creative_call_to_action_destinationsstring[]

  Filter by lead generation form URN(s). Provide a list of ad form URNs (e.g., 'urn:li:adForm:123456'). Multiple forms are ORed together.

Parámetros de salida

• dataobjectObligatorio

  Data from the action execution

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• qstringenum

  Query type - use 'eventsByOrganizer' to search by organizer or 'organizerLeadGenFormEnabledEvents' for lead gen enabled events

  eventsByOrganizerorganizerLeadGenFormEnabledEvents
• countinteger

  Number of events to return per page (max 100)

• startinteger

  Pagination start index (0-based)

• organizerstringObligatorio

  Organization or person URN of the event organizer (e.g., 'urn:li:organization:7185861')

• sortOrderstringenum

  Event sort order.

  START_TIME_ASCEND_TIME_DESC
• entryCriteriastringenum

  Event entry criteria.

  PUBLICGATED
• lifeCycleStatestringenum

  Event lifecycle state.

  UPCOMINGONGOINGPAST
• excludeCancelledboolean

  If true, exclude cancelled events from results

Parámetros de salida

• dataobjectObligatorio

  Data from the action execution

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• patchobjectObligatorio

  Patch object containing the $set operation with fields to update. For published forms, only specific fields can be updated (headline, description, legalDisclaimer, landingPageUrl, privacyPageUrl, thankYouMessage, thankYouPageCta, state). Pre-published forms (DRAFT or not linked to active campaigns) can have all fields updated.

• form_idintegerObligatorio

  The ID of the lead form to update.

Parámetros de salida

• dataobjectObligatorio

  Data from the action execution

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• rolestringObligatorioenum

  The role to update. For external API calls, only DIRECT_SPONSORED_CONTENT_POSTER is supported.

  ADMINISTRATORDIRECT_SPONSORED_CONTENT_POSTERRECRUITING_POSTERLEAD_CAPTURE_ADMINISTRATORLEAD_GEN_FORMS_MANAGERANALYSTCURATORCONTENT_ADMINISTRATOR
• statestringObligatorioenum

  The role state to set. For external API calls, only REQUESTED is supported.

  APPROVEDREJECTEDREQUESTEDREVOKED
• organizationstringObligatorio

  The organizational entity URN for which access control information is being updated. Must be in the format 'urn:li:organization:{id}' or 'urn:li:organizationBrand:{id}'.

• roleAssigneestringObligatorio

  The person URN of the member being assigned the role. Must be in the format 'urn:li:person:{id}'. Note: The PUT API works only when the user is requesting the DIRECT_SPONSORED_CONTENT_POSTER role to an organization for themselves and not on behalf of others.

Parámetros de salida

• dataobjectObligatorio

  Data from the action execution

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not