Caution: You are viewing documentation for the API's REST interface. Most of our official client libraries use gRPC. See the REST Introduction for details.

FeedMapping

Stay organized with collections Save and categorize content based on your preferences.

A feed mapping.

JSON representation
{
  "resourceName": string,
  "attributeFieldMappings": [
    {
      object (AttributeFieldMapping)
    }
  ],
  "status": enum (FeedMappingStatus),
  "feed": string,

  // Union field target can be only one of the following:
  "placeholderType": enum (PlaceholderType),
  "criterionType": enum (FeedMappingCriterionType)
  // End of list of possible types for union field target.
}
Fields
resourceName

string

Immutable. The resource name of the feed mapping. Feed mapping resource names have the form:

customers/{customerId}/feedMappings/{feedId}~{feed_mapping_id}

attributeFieldMappings[]

object (AttributeFieldMapping)

Immutable. Feed attributes to field mappings. These mappings are a one-to-many relationship meaning that 1 feed attribute can be used to populate multiple placeholder fields, but 1 placeholder field can only draw data from 1 feed attribute. Ad Customizer is an exception, 1 placeholder field can be mapped to multiple feed attributes. Required.

status

enum (FeedMappingStatus)

Output only. Status of the feed mapping. This field is read-only.

feed

string

Immutable. The feed of this feed mapping.

Union field target. Feed mapping target. Can be either a placeholder or a criterion. For a given feed, the active FeedMappings must have unique targets. Required. target can be only one of the following:
placeholderType

enum (PlaceholderType)

Immutable. The placeholder type of this mapping (i.e., if the mapping maps feed attributes to placeholder fields).

criterionType

enum (FeedMappingCriterionType)

Immutable. The criterion type of this mapping (i.e., if the mapping maps feed attributes to criterion fields).

AttributeFieldMapping

Maps from feed attribute id to a placeholder or criterion field id.

JSON representation
{
  "feedAttributeId": string,
  "fieldId": string,

  // Union field field can be only one of the following:
  "sitelinkField": enum (SitelinkPlaceholderField),
  "callField": enum (CallPlaceholderField),
  "appField": enum (AppPlaceholderField),
  "locationField": enum (LocationPlaceholderField),
  "affiliateLocationField": enum (AffiliateLocationPlaceholderField),
  "calloutField": enum (CalloutPlaceholderField),
  "structuredSnippetField": enum (StructuredSnippetPlaceholderField),
  "messageField": enum (MessagePlaceholderField),
  "priceField": enum (PricePlaceholderField),
  "promotionField": enum (PromotionPlaceholderField),
  "adCustomizerField": enum (AdCustomizerPlaceholderField),
  "dsaPageFeedField": enum (DsaPageFeedCriterionField),
  "locationExtensionTargetingField": enum (LocationExtensionTargetingCriterionField),
  "educationField": enum (EducationPlaceholderField),
  "flightField": enum (FlightPlaceholderField),
  "customField": enum (CustomPlaceholderField),
  "hotelField": enum (HotelPlaceholderField),
  "realEstateField": enum (RealEstatePlaceholderField),
  "travelField": enum (TravelPlaceholderField),
  "localField": enum (LocalPlaceholderField),
  "jobField": enum (JobPlaceholderField),
  "imageField": enum (ImagePlaceholderField)
  // End of list of possible types for union field field.
}
Fields
feedAttributeId

string (int64 format)

Immutable. Feed attribute from which to map.

fieldId

string (int64 format)

Output only. The placeholder field ID. If a placeholder field enum is not published in the current API version, then this field will be populated and the field oneof will be empty. This field is read-only.

Union field field. Placeholder or criterion field to be populated using data from the above feed attribute. Required. field can be only one of the following:
callField

enum (CallPlaceholderField)

Immutable. Call Placeholder Fields.

appField

enum (AppPlaceholderField)

Immutable. App Placeholder Fields.

locationField

enum (LocationPlaceholderField)

Output only. Location Placeholder Fields. This field is read-only.

affiliateLocationField

enum (AffiliateLocationPlaceholderField)

Output only. Affiliate Location Placeholder Fields. This field is read-only.

calloutField

enum (CalloutPlaceholderField)

Immutable. Callout Placeholder Fields.

structuredSnippetField

enum (StructuredSnippetPlaceholderField)

Immutable. Structured Snippet Placeholder Fields.

messageField

enum (MessagePlaceholderField)

Immutable. Message Placeholder Fields.

priceField

enum (PricePlaceholderField)

Immutable. Price Placeholder Fields.

promotionField

enum (PromotionPlaceholderField)

Immutable. Promotion Placeholder Fields.

adCustomizerField

enum (AdCustomizerPlaceholderField)

Immutable. Ad Customizer Placeholder Fields

dsaPageFeedField

enum (DsaPageFeedCriterionField)

Immutable. Dynamic googleAds.search Ad Page Feed Fields.

locationExtensionTargetingField

enum (LocationExtensionTargetingCriterionField)

Immutable. Location Target Fields.

educationField

enum (EducationPlaceholderField)

Immutable. Education Placeholder Fields

flightField

enum (FlightPlaceholderField)

Immutable. Flight Placeholder Fields

customField

enum (CustomPlaceholderField)

Immutable. Custom Placeholder Fields

hotelField

enum (HotelPlaceholderField)

Immutable. Hotel Placeholder Fields

realEstateField

enum (RealEstatePlaceholderField)

Immutable. Real Estate Placeholder Fields

travelField

enum (TravelPlaceholderField)

Immutable. Travel Placeholder Fields

localField

enum (LocalPlaceholderField)

Immutable. Local Placeholder Fields

jobField

enum (JobPlaceholderField)

Immutable. Job Placeholder Fields

imageField

enum (ImagePlaceholderField)

Immutable. Image Placeholder Fields

SitelinkPlaceholderField

Possible values for Sitelink placeholder fields.

Enums
UNSPECIFIED Not specified.
UNKNOWN Used for return value only. Represents value unknown in this version.
TEXT Data Type: STRING. The link text for your sitelink.
LINE_1 Data Type: STRING. First line of the sitelink description.
LINE_2 Data Type: STRING. Second line of the sitelink description.
FINAL_URLS Data Type: URL_LIST. Final URLs for the sitelink when using Upgraded URLs.
FINAL_MOBILE_URLS Data Type: URL_LIST. Final Mobile URLs for the sitelink when using Upgraded URLs.
TRACKING_URL Data Type: URL. Tracking template for the sitelink when using Upgraded URLs.
FINAL_URL_SUFFIX Data Type: STRING. Final URL suffix for sitelink when using parallel tracking.

CallPlaceholderField

Possible values for Call placeholder fields.

Enums
UNSPECIFIED Not specified.
UNKNOWN Used for return value only. Represents value unknown in this version.
PHONE_NUMBER Data Type: STRING. The advertiser's phone number to append to the ad.
COUNTRY_CODE Data Type: STRING. Uppercase two-letter country code of the advertiser's phone number.
TRACKED Data Type: BOOLEAN. Indicates whether call tracking is enabled. Default: true.
CONVERSION_TYPE_ID Data Type: INT64. The ID of an AdCallMetricsConversion object. This object contains the phoneCallDurationfield which is the minimum duration (in seconds) of a call to be considered a conversion.
CONVERSION_REPORTING_STATE Data Type: STRING. Indicates whether this call extension uses its own call conversion setting or follows the account level setting. Valid values are: USE_ACCOUNT_LEVEL_CALL_CONVERSION_ACTION and USE_RESOURCE_LEVEL_CALL_CONVERSION_ACTION.

AppPlaceholderField

Possible values for App placeholder fields.

Enums
UNSPECIFIED Not specified.
UNKNOWN Used for return value only. Represents value unknown in this version.
STORE Data Type: INT64. The application store that the target application belongs to. Valid values are: 1 = Apple iTunes Store; 2 = Google Play Store.
ID Data Type: STRING. The store-specific ID for the target application.
URL Data Type: STRING. The destination URL of the in-app link.
FINAL_URLS Data Type: URL_LIST. Final URLs for the in-app link when using Upgraded URLs.
FINAL_MOBILE_URLS Data Type: URL_LIST. Final Mobile URLs for the in-app link when using Upgraded URLs.
TRACKING_URL Data Type: URL. Tracking template for the in-app link when using Upgraded URLs.
FINAL_URL_SUFFIX Data Type: STRING. Final URL suffix for the in-app link when using parallel tracking.

LocationPlaceholderField

Possible values for Location