---
title: "Retrieves the current editorial sponsorships from GAM"
method: GET
path: "/gam/update-editorial-sponsorships"
tags: ["Editorial Sponsorships"]
---

# Retrieves the current editorial sponsorships from GAM

`GET /gam/update-editorial-sponsorships`

## Request

- Base URL: `http://dev.theverge.com:3002/api`
- URL: `http://dev.theverge.com:3002/api/gam/update-editorial-sponsorships`
- Auth: none declared

Retrieves editorial sponsorships data for the current network. Cache updates are now handled by CLI scripts.

## Response `200`

Successfully retrieved editorial sponsorships

- object
  - `data` EditorialSponsorshipResponse, required
    - `lineItems` LineItemWithTargeting[], required
      - `targetingPairs` TargetingPair[], required
        - `keyId` string, required
        - `valueId` string, required
      - `decodedTargeting` DecodedTargetingPair[], required
        - `key` CustomTargetingKey, required
          - `id` string, required: The ID of the CustomTargetingKey. This value is readonly and is populated by Google.
          - `name` string, required: Name of the key. Keys can contain up to 10 characters each. Allowed characters are alphanumeric except: ", ', =, !, +, #, *, ~, ;, ^, (, ), <, >, [, ], whitespace
          - `displayName` string, required: Descriptive name for the key.
          - `type` 'PREDEFINED' | 'FREEFORM', required: Type of the key - determines if users select predefined values or create new ones
          - `status` 'ACTIVE' | 'INACTIVE' | 'UNKNOWN', required: Status of the key (read-only)
          - `reportableType` 'UNKNOWN' | 'ON' | 'OFF' | 'CUSTOM_DIMENSION', required: Reportable state of the key
        - `value` CustomTargetingValue, required
          - `customTargetingKeyId` string, required: The ID of the CustomTargetingKey this value belongs to
          - `id` string, required: The ID of the CustomTargetingValue. This value is readonly and is populated by Google.
          - `name` string, required: Name of the value. Values can contain up to 40 characters each. Allowed characters are alphanumeric except: ", ', =, !, +, #, *, ~, ;, ^, (, ), <, >, [, ]
          - `displayName` string, required: Descriptive name for the value
          - `matchType` 'UNKNOWN' | 'EXACT' | 'BROAD' | 'PREFIX' | 'BROAD_PREFIX' | 'SUFFIX' | 'CONTAINS', required: The way in which the name strings will be matched
          - `status` 'ACTIVE' | 'INACTIVE' | 'UNKNOWN', required: Status of the value (read-only)
      - `orderId` string, required
      - `id` string, required
      - `name` string, required
      - `externalId` string, required
      - `orderName` string, required
      - `startDateTime` DateTime, required
        - `date` object, required
          - `year` number, required
          - `month` number, required
          - `day` number, required
        - `hour` number, required
        - `minute` number, required
        - `second` number, required
        - `timeZoneId` string, required
      - `startDateTimeType` string, required
      - `endDateTime` DateTime
        - `date` object, required
          - `year` number, required
          - `month` number, required
          - `day` number, required
        - `hour` number, required
        - `minute` number, required
        - `second` number, required
        - `timeZoneId` string, required
      - `autoExtensionDays` number, required
      - `unlimitedEndDateTime` boolean, required
      - `creativeRotationType` string, required
      - `deliveryRateType` string, required
      - `deliveryForecastSource` string, required
      - `roadblockingType` string, required
      - `skippableAdType` string, required
      - `lineItemType` string, required
      - `priority` number, required
      - `costPerUnit` CostUnit, required
        - `currencyCode` string, required
        - `microAmount` string, required
      - `valueCostPerUnit` CostUnit, required
        - `currencyCode` string, required
        - `microAmount` string, required
      - `costType` string, required
      - `discountType` string, required
      - `discount` string, required
      - `contractedUnitsBought` string, required
      - `creativePlaceholders` CreativePlaceholder[], required
        - `size` Size, required
          - `width` number, required
          - `height` number, required
          - `isAspectRatio` boolean, required
        - `expectedCreativeCount` number, required
        - `creativeSizeType` 'PIXEL' | 'INTERSTITIAL', required
        - `targetingName` string
        - `isAmpOnly` boolean, required
      - `environmentType` string, required
      - `companionDeliveryOption` string, required
      - `allowOverbook` boolean, required
      - `skipInventoryCheck` boolean, required
      - `skipCrossSellingRuleWarningChecks` boolean, required
      - `reserveAtCreation` boolean, required
      - `stats` Stats
        - `impressionsDelivered` string, required
        - `clicksDelivered` string, required
        - `videoCompletionsDelivered` string, required
        - `videoStartsDelivered` string, required
        - `viewableImpressionsDelivered` string, required
      - `budget` CostUnit, required
        - `currencyCode` string, required
        - `microAmount` string, required
      - `status` string, required
      - `reservationStatus` string, required
      - `isArchived` boolean, required
      - `webPropertyCode` string, required
      - `disableSameAdvertiserCompetitiveExclusion` boolean, required
      - `lastModifiedByApp` string, required
      - `competitiveConstraintScope` string, required
      - `lastModifiedDateTime` DateTime, required
        - `date` object, required
          - `year` number, required
          - `month` number, required
          - `day` number, required
        - `hour` number, required
        - `minute` number, required
        - `second` number, required
        - `timeZoneId` string, required
      - `creationDateTime` DateTime, required
        - `date` object, required
          - `year` number, required
          - `month` number, required
          - `day` number, required
        - `hour` number, required
        - `minute` number, required
        - `second` number, required
        - `timeZoneId` string, required
      - `customFieldValues` CustomFieldValue[], required
        - `attributes` object, required
          - `xsi:type` 'CustomFieldValue', required
        - `customFieldId` string, required
        - `value` object, required
          - `attributes` object, required
            - `xsi:type` 'TextValue' | 'NumberValue', required
          - `value` string, required
      - `isMissingCreatives` boolean, required
      - `youtubeKidsRestricted` boolean, required
      - `videoMaxDuration` string, required
      - `primaryGoal` Goal, required
        - `goalType` 'DAILY' | 'LIFETIME', required
        - `unitType` 'IMPRESSIONS', required
        - `units` string, required
      - `secondaryGoals` Goal[]
        - `goalType` 'DAILY' | 'LIFETIME', required
        - `unitType` 'IMPRESSIONS', required
        - `units` string, required
      - `childContentEligibility` string, required
      - `targeting` Targeting, required
        - `geoTargeting` object
          - `targetedLocations` Location[], required
            - `id` string, required
            - `type` string, required
            - `displayName` string, required
        - `inventoryTargeting` object, required
          - `targetedAdUnits` AdUnit[]
            - `adUnitId` string, required
            - `includeDescendants` boolean, required
          - `targetedPlacementIds` string[]
        - `customTargeting` object, required
          - `logicalOperator` 'OR', required
          - `children` CustomCriteriaSet[], required
            - `attributes` object, required
              - …
            - `logicalOperator` 'OR' | 'AND', required
            - `children` union[], required
              - …
        - `requestPlatformTargeting` object
          - `targetedRequestPlatforms` string[], required
      - `creativeTargetings` CreativeTargeting[]
        - `name` string, required
        - `targeting` object, required
          - `customTargeting` object, required
            - `logicalOperator` 'OR', required
            - `children` CustomCriteriaSet[], required
              - …
      - `notes` string
      - `deliveryData` object
        - `units` string[], required
      - `deliveryIndicator` object
        - `expectedDeliveryPercentage` string, required
        - `actualDeliveryPercentage` string, required
      - `effectiveAppliedLabels` object[]
        - `labelId` string, required
        - `isNegated` boolean, required
    - `editorialSponsorships` EditorialSponsorship[], required
      - `orderId` string, required
      - `id` string, required
      - `name` string, required
      - `orderName` string, required
      - `startDateTime` string, required
      - `endDateTime` string, nullable, required
      - `status` string, required
      - `decodedTargeting` SimpleDecodedTargetingPairs[], required
        - `key` string, required
        - `value` string, required
    - `totalUnfilteredLineItems` number, required

## Other responses

- `401`: Unauthorized access
- `500`: Internal server error

---

[API](https://skmtc.dev/theverge/apis/the-verge-api-documentation.md) - [All operations](https://skmtc.dev/theverge/apis/the-verge-api-documentation/llms.txt) - [OpenAPI document](https://skmtc.dev/theverge/apis/the-verge-api-documentation/revisions/f44a9b8ebfc3?raw)