REST Resource: advertisers.adGroupAds

    • The AdGroupAd resource represents a single ad within an ad group and includes details such as name, advertiser ID, ad group ID, display name, entity status, and a list of URLs.

    • The content describes various ad types including DisplayVideoSourceAd, MastheadAd, InStreamAd, NonSkippableAd, BumperAd, AudioAd, VideoDiscoveryAd, and VideoPerformanceAd, each with specific details and JSON representations.

    • Common attributes for some in-stream ad types are shared through the CommonInStreamAttribute object, including display URL, final URL, tracking URL, action button label, action headline, and video details.

    • The YoutubeVideoDetails resource provides information about a YouTube video used in an ad, including its ID and reason for unavailability.

    • The document also defines enums for VideoUnavailableReason , VideoAspectRatio , Thumbnail , and AdUrlType to categorize specific aspects of video and ad URLs.

    Resource: AdGroupAd

    A single ad associated with an ad group.

    JSON representation 
     { 
 "name" 
 : 
 string 
 , 
 "advertiserId" 
 : 
 string 
 , 
 "adGroupAdId" 
 : 
 string 
 , 
 "adGroupId" 
 : 
 string 
 , 
 "displayName" 
 : 
 string 
 , 
 "adPolicy" 
 : 
 { 
 object (  AdPolicy 
 
) 
 } 
 , 
 "entityStatus" 
 : 
 enum (  EntityStatus 
 
) 
 , 
 "adUrls" 
 : 
 [ 
 { 
 object (  AdUrl 
 
) 
 } 
 ] 
 , 
 "dcmTrackingInfo" 
 : 
 { 
 object (  DcmTrackingInfo 
 
) 
 } 
 , 
 // Union field ad_details 
can be only one of the following: 
 "displayVideoSourceAd" 
 : 
 { 
 object (  DisplayVideoSourceAd 
 
) 
 } 
 , 
 "mastheadAd" 
 : 
 { 
 object (  MastheadAd 
 
) 
 } 
 , 
 "inStreamAd" 
 : 
 { 
 object (  InStreamAd 
 
) 
 } 
 , 
 "nonSkippableAd" 
 : 
 { 
 object (  NonSkippableAd 
 
) 
 } 
 , 
 "bumperAd" 
 : 
 { 
 object (  BumperAd 
 
) 
 } 
 , 
 "audioAd" 
 : 
 { 
 object (  AudioAd 
 
) 
 } 
 , 
 "videoDiscoverAd" 
 : 
 { 
 object (  VideoDiscoveryAd 
 
) 
 } 
 , 
 "videoPerformanceAd" 
 : 
 { 
 object (  VideoPerformanceAd 
 
) 
 } 
 , 
 "demandGenVideoAd" 
 : 
 { 
 object (  DemandGenVideoAd 
 
) 
 } 
 , 
 "demandGenImageAd" 
 : 
 { 
 object (  DemandGenImageAd 
 
) 
 } 
 , 
 "demandGenCarouselAd" 
 : 
 { 
 object (  DemandGenCarouselAd 
 
) 
 } 
 , 
 "demandGenProductAd" 
 : 
 { 
 object (  DemandGenProductAd 
 
) 
 } 
 // End of list of possible types for union field ad_details 
. 
 }
    Fields
    name

    string

    Output only. The resource name of the ad.

    advertiserId

    string ( int64 format)

    Output only. The unique ID of the advertiser the ad belongs to.

    adGroupAdId

    string ( int64 format)

    Output only. The unique ID of the ad. Assigned by the system.

    adGroupId

    string ( int64 format)

    Required. Immutable. The unique ID of the ad group that the ad belongs to.

    displayName

    string

    Required. The display name of the ad.

    Must be UTF-8 encoded with a maximum size of 255 bytes.

    adPolicy

    object ( AdPolicy )

    Output only. The policy approval status of the ad.

    entityStatus

    enum ( EntityStatus )

    Required. The entity status of the ad.

    adUrls[]

    object ( AdUrl )

    Output only. List of URLs used by the ad.

    dcmTrackingInfo

    object ( DcmTrackingInfo )

    Optional. The DCM tracking ad info. Only valid for Demand Gen ads.

    To remove the DCM tracking ad info, please leave this field empty.

    Union field ad_details . The details of the ad. ad_details can be only one of the following:
    displayVideoSourceAd

    object ( DisplayVideoSourceAd )

    Output only. Details of an ad sourced from a Display & Video 360 creative.

    mastheadAd

    object ( MastheadAd )

    Output only. Details of an ad served on the YouTube Home feed .

    inStreamAd

    object ( InStreamAd )

    Output only. Details of an in-stream ad skippable after 5 seconds , used for brand awareness or reach marketing objectives.

    nonSkippableAd

    object ( NonSkippableAd )

    Output only. Details of a non-skippable short in-stream video ad , between 6 and 15 seconds, used for reach marketing objectives.

    bumperAd

    object ( BumperAd )

    Output only. Details of a non-skippable short video ad , equal to or less than 6 seconds, used for reach.

    audioAd

    object ( AudioAd )

    Output only. Details of an audio ad used for reach marketing objectives.

    videoDiscoverAd

    object ( VideoDiscoveryAd )

    Output only. Details of an ad promoting a video that shows in places of discovery.

    videoPerformanceAd

    object ( VideoPerformanceAd )

    Output only. Details of an ad used in a video action campaign to drive actions to the business, service or product.

    demandGenVideoAd

    object ( DemandGenVideoAd )

    Details of a Demand Gen video ad .

    demandGenImageAd

    object ( DemandGenImageAd )

    Details of a Demand Gen image ad .

    demandGenProductAd

    object ( DemandGenProductAd )

    Details of a Demand Gen product ad .

    AdPolicy

    A single ad policy associated with an ad group ad.

    JSON representation 
     { 
 "adPolicyApprovalStatus" 
 : 
 enum (  AdPolicyApprovalStatus 
 
) 
 , 
 "adPolicyReviewStatus" 
 : 
 enum (  AdPolicyReviewStatus 
 
) 
 , 
 "adPolicyTopicEntry" 
 : 
 [ 
 { 
 object (  AdPolicyTopicEntry 
 
) 
 } 
 ] 
 }
    Fields
    adPolicyApprovalStatus

    enum ( AdPolicyApprovalStatus )

    The policy approval status of an ad, indicating the approval decision.
    adPolicyReviewStatus

    enum ( AdPolicyReviewStatus )

    The policy review status of an ad, indicating where in the review process the ad is currently.
    adPolicyTopicEntry[]

    object ( AdPolicyTopicEntry )

    The entries for each policy topic identified as relating to the ad. Each entry includes the topic, restriction level, and guidance on how to fix policy issues.

    AdPolicyApprovalStatus

    Possible statuses of an ad policy approval.

    Enums
    AD_POLICY_APPROVAL_STATUS_UNKNOWN Unknown or not specified.
    DISAPPROVED Will not serve.
    APPROVED_LIMITED Will serve with restrictions.
    APPROVED Will serve without restrictions.
    AREA_OF_INTEREST_ONLY Will not serve in targeted countries, but may serve for users who are searching for information about the targeted countries.

    AdPolicyReviewStatus

    Possible statuses of an ad policy review.

    Enums
    AD_POLICY_REVIEW_STATUS_UNKNOWN Unknown or not specified.
    REVIEW_IN_PROGRESS Currently under review.
    REVIEWED Primary review complete. Other reviews may still be in progress.
    UNDER_APPEAL Resubmitted for approval or a policy decision has been appealed.
    ELIGIBLE_MAY_SERVE Deemed eligible and may be serving. Further review could still follow.

    AdPolicyTopicEntry

    An entry describing how an ad has been identified as relating to an ad policy.

    JSON representation 
     { 
 "policyTopic" 
 : 
 string 
 , 
 "policyLabel" 
 : 
 string 
 , 
 "policyTopicDescription" 
 : 
 string 
 , 
 "policyTopicType" 
 : 
 enum (  AdPolicyTopicEntryType 
 
) 
 , 
 "policyDecisionType" 
 : 
 enum (  AdPolicyDecisionType 
 
) 
 , 
 "policyEnforcementMeans" 
 : 
 enum (  AdPolicyEnforcementMeans 
 
) 
 , 
 "policyTopicEvidences" 
 : 
 [ 
 { 
 object (  AdPolicyTopicEvidence 
 
) 
 } 
 ] 
 , 
 "policyTopicConstraints" 
 : 
 [ 
 { 
 object (  AdPolicyTopicConstraint 
 
) 
 } 
 ] 
 , 
 "helpCenterLink" 
 : 
 string 
 , 
 "appealInfo" 
 : 
 { 
 object (  AdPolicyTopicAppealInfo 
 
) 
 } 
 }
    Fields
    policyTopic

    string

    The policy topic.

    Examples include "TRADEMARKS", "ALCOHOL", etc.
    policyLabel

    string

    Localized label text for policy.

    Examples include "Trademarks in text", "Contains Alcohol", etc.
    policyTopicDescription

    string

    A short summary description of the policy topic.
    policyTopicType

    enum ( AdPolicyTopicEntryType )

    How ad serving will be affected due to the relation to the ad policy topic.
    policyDecisionType

    enum ( AdPolicyDecisionType )

    The source of the policy decision.
    policyEnforcementMeans

    enum ( AdPolicyEnforcementMeans )

    The policy enforcement means used in the policy review.
    policyTopicEvidences[]

    object ( AdPolicyTopicEvidence )

    The evidence used in the policy decision.
    policyTopicConstraints[]

    object ( AdPolicyTopicConstraint )

    The serving constraints relevant to the policy decision.
    appealInfo

    object ( AdPolicyTopicAppealInfo )

    Information on how to appeal the policy decision.

    AdPolicyTopicEntryType

    Possible serving impacts of an ad policy topic.

    Enums
    AD_POLICY_TOPIC_ENTRY_TYPE_UNKNOWN Unknown or not specified.
    PROHIBITED The resource will not serve.
    FULLY_LIMITED The resource will not serve in all targeted countries.
    LIMITED The resource cannot serve in some countries.
    DESCRIPTIVE The resource can serve.
    BROADENING The resource can serve, and may serve beyond normal coverage.
    AREA_OF_INTEREST_ONLY The resource is constrained for all targeted countries, but may serve for users who are searching for information about the targeted countries.

    AdPolicyDecisionType

    Possible sources of a policy decision.

    Enums
    AD_POLICY_DECISION_TYPE_UNKNOWN Unknown or not specified.
    PURSUANT_TO_NOTICE The decision is from a legal notice, court order, or trademark content owner complaint, etc.
    GOOGLE_INVESTIGATION The decision is from a Google-owned investigation.

    AdPolicyEnforcementMeans

    Possible policy enforcement means used in the policy review.

    Enums
    AD_POLICY_ENFORCEMENT_MEANS_UNKNOWN Unknown or not specified.
    AUTOMATED The enforcement process was fully automated.
    HUMAN_REVIEW A human was partially or fully involved in the decision enforcement process.

    AdPolicyTopicEvidence

    Evidence information used in the policy decision.

    JSON representation 
     { 
 // Union field value 
can be only one of the following: 
 "textList" 
 : 
 { 
 object (  TextList 
 
) 
 } 
 , 
 "websiteList" 
 : 
 { 
 object (  WebsiteList 
 
) 
 } 
 , 
 "httpCode" 
 : 
 integer 
 , 
 "languageCode" 
 : 
 string 
 , 
 "destinationTextList" 
 : 
 { 
 object (  DestinationTextList 
 
) 
 } 
 , 
 "destinationMismatch" 
 : 
 { 
 object (  DestinationMismatch 
 
) 
 } 
 , 
 "destinationNotWorking" 
 : 
 { 
 object (  DestinationNotWorking 
 
) 
 } 
 , 
 "trademark" 
 : 
 { 
 object (  Trademark 
 
) 
 } 
 , 
 "legalRemoval" 
 : 
 { 
 object (  LegalRemoval 
 
) 
 } 
 , 
 "counterfeit" 
 : 
 { 
 object (  Counterfeit 
 
) 
 } 
 , 
 "regionalRequirements" 
 : 
 { 
 object (  RegionalRequirements 
 
) 
 } 
 // End of list of possible types for union field value 
. 
 }
    Fields
    Union field value . The evidence for the policy decision. value can be only one of the following:
    textList

    object ( TextList )

    List of evidence found in the text of the ad.

    websiteList

    object ( WebsiteList )

    List of websites linked with the ad.

    httpCode

    integer

    HTTP code returned when the final URL was crawled.

    languageCode

    string

    The language the ad was detected to be written in.

    This field uses IETF language tags, such as "en-US".

    destinationTextList

    object ( DestinationTextList )

    The text in the destination of the ad that is causing a policy violation.

    destinationMismatch

    object ( DestinationMismatch )

    A mismatch between the ad destination URLs.

    destinationNotWorking

    object ( DestinationNotWorking )

    Information on HTTP or DNS errors related to the ad destination.

    trademark

    object ( Trademark )

    Trademark terms that caused a policy violation.

    legalRemoval

    object ( LegalRemoval )

    Legal related regulation enforcement that caused a policy violation.

    counterfeit

    object ( Counterfeit )

    Counterfeit enforcement that caused a policy violation.

    regionalRequirements

    object ( RegionalRequirements )

    T&S proactive enforcement that caused a policy violation.

    TextList

    A list of fragments of text that violated the policy.

    JSON representation 
     { 
 "texts" 
 : 
 [ 
 string 
 ] 
 }
    Fields
    texts[]

    string

    The fragments of text from the resource that caused the policy finding.

    WebsiteList

    A list of websites that violated the policy.

    JSON representation 
     { 
 "websites" 
 : 
 [ 
 string 
 ] 
 }
    Fields
    websites[]

    string

    Websites that caused the policy finding.

    DestinationTextList

    A list of destination text that violated the policy.

    JSON representation 
     { 
 "destinationTexts" 
 : 
 [ 
 string 
 ] 
 }
    Fields
    destinationTexts[]

    string

    Destination text that caused the policy finding.

    DestinationMismatch

    Details on a mismatch between destination URL types.

    JSON representation 
     { 
 "uriTypes" 
 : 
 [ 
 enum (  AdPolicyTopicEvidenceDestinationMismatchUrlType 
 
) 
 ] 
 }
    Fields
    uriTypes[]

    enum ( AdPolicyTopicEvidenceDestinationMismatchUrlType )

    The set of URLs that do not match. The list can include single or multiple uri types.

    Example 1: [ DISPLAY_URL , FINAL_URL ] means ad display URL does not match with the ad final URL.

    Example 2: [ FINAL_URL ] means ad final URL did not match the crawled url, which is also considered as destination mismatch.

    AdPolicyTopicEvidenceDestinationMismatchUrlType

    Possible URL types.

    Enums
    AD_POLICY_TOPIC_EVIDENCE_DESTINATION_MISMATCH_URL_TYPE_UNKNOWN Not specified or unknown.
    DISPLAY_URL The display URL.
    FINAL_URL The final URL.
    FINAL_MOBILE_URL The final mobile URL.
    TRACKING_URL The tracking URL.
    MOBILE_TRACKING_URL The mobile tracking URL.

    DestinationNotWorking

    Details for on HTTP or DNS errors related to the ad destination.

    JSON representation 
     { 
 "expandedUri" 
 : 
 string 
 , 
 "device" 
 : 
 enum (  AdPolicyTopicEvidenceDestinationNotWorkingDeviceType 
 
) 
 , 
 "lastCheckedTime" 
 : 
 string 
 , 
 // Union field reason 
can be only one of the following: 
 "dnsErrorType" 
 : 
 enum (  AdPolicyTopicEvidenceDestinationNotWorkingDnsErrorType 
 
) 
 , 
 "httpErrorCode" 
 : 
 string 
 // End of list of possible types for union field reason 
. 
 }
    Fields
    expandedUri

    string

    The full URL that didn't work.

    device

    enum ( AdPolicyTopicEvidenceDestinationNotWorkingDeviceType )

    The device where visiting the URL resulted in the error.

    lastCheckedTime

    string ( Timestamp format)

    The last time the error was seen when navigating to URL.

    Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z" , "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30" .

    Union field reason . The HTTP or DNS error. reason can be only one of the following:
    dnsErrorType

    enum ( AdPolicyTopicEvidenceDestinationNotWorkingDnsErrorType )

    The type of DNS error.

    httpErrorCode

    string ( int64 format)

    The HTTP error code.

    AdPolicyTopicEvidenceDestinationNotWorkingDnsErrorType

    Possible DNS error types.

    Enums
    AD_POLICY_TOPIC_EVIDENCE_DESTINATION_NOT_WORKING_DNS_ERROR_TYPE_UNKNOWN Not specified or unknown.
    HOSTNAME_NOT_FOUND Host name not found in DNS when fetching landing page.
    GOOGLE_CRAWLER_DNS_ISSUE Google could not crawl the landing page when communicating with DNS.

    AdPolicyTopicEvidenceDestinationNotWorkingDeviceType

    Possible devices that that saw an error when visiting the URL.

    Enums
    AD_POLICY_TOPIC_EVIDENCE_DESTINATION_NOT_WORKING_DEVICE_TYPE_UNKNOWN Not specified or unknown.
    DESKTOP Desktop device.
    ANDROID Android device.
    IOS iOS device.

    Trademark

    Trademark terms that caused a policy violation.

    JSON representation 
     { 
 "owner" 
 : 
 string 
 , 
 "term" 
 : 
 string 
 , 
 "countryRestrictions" 
 : 
 [ 
 { 
 object (  AdPolicyCriterionRestriction 
 
) 
 } 
 ] 
 }
    Fields
    owner

    string

    The trademark content owner.
    term

    string

    The trademark term.
    countryRestrictions[]

    object ( AdPolicyCriterionRestriction )

    Countries where the policy violation is relevant.

    AdPolicyCriterionRestriction

    Represents a country restriction.

    JSON representation 
     { 
 "countryCriterionId" 
 : 
 string 
 , 
 "countryLabel" 
 : 
 string 
 }
    Fields
    countryCriterionId

    string ( int64 format)

    The country criterion id.
    countryLabel

    string

    Localized name for the country. May be empty.

    LegalRemoval

    Legal related regulation enforcement, either from DMCA or local legal regulation.

    JSON representation 
     { 
 "complaintType" 
 : 
 enum (  AdPolicyTopicEvidenceLegalRemovalComplaintType 
 
) 
 , 
 "countryRestrictions" 
 : 
 [ 
 { 
 object (  AdPolicyCriterionRestriction 
 
) 
 } 
 ] 
 , 
 "restrictedUris" 
 : 
 [ 
 string 
 ] 
 , 
 // Union field type 
can be only one of the following: 
 "dmca" 
 : 
 { 
 object (  Dmca 
 
) 
 } 
 , 
 "localLegal" 
 : 
 { 
 object (  LocalLegal 
 
) 
 } 
 // End of list of possible types for union field type 
. 
 }
    Fields
    complaintType

    enum ( AdPolicyTopicEvidenceLegalRemovalComplaintType )

    The type of complaint causing the legal removal.

    countryRestrictions[]

    object ( AdPolicyCriterionRestriction )

    The countries restricted due to the legal removal.

    restrictedUris[]

    string

    The urls restricted due to the legal removal.

    Union field type . Details on the type of legal removal. type can be only one of the following:
    dmca

    object ( Dmca )

    Details on the DMCA regulation legal removal.

    Dmca

    DMCA complaint details.

    JSON representation 
     { 
 "complainant" 
 : 
 string 
 }
    Fields
    complainant

    string

    The entity who made the legal complaint.

    LocalLegal

    Local legal regulation details.

    JSON representation 
     { 
 "lawType" 
 : 
 string 
 }
    Fields
    lawType

    string

    Type of law for the legal notice.

    AdPolicyTopicEvidenceLegalRemovalComplaintType

    Possible complaint types for legal removal.

    Enums
    COPYRIGHT

    Copyright.

    Only applies to DMCA.
    COURT_ORDER

    Court order.

    Only applies to local legal.

    Counterfeit

    Details on the counterfeit enforcement that caused a policy violation.

    JSON representation 
     { 
 "owners" 
 : 
 [ 
 string 
 ] 
 }
    Fields
    owners[]

    string

    The content or product owners that made a complaint.

    RegionalRequirements

    Trust & Safety (T&S) proactive enforcement for policies meant to address regional requirements. This is considered a Google-owned investigation instead of a regulation notice since it's proactive T&S enforcement.

    JSON representation 
     { 
 "regionalRequirementsEntries" 
 : 
 [ 
 { 
 object (  RegionalRequirementsEntry 
 
) 
 } 
 ] 
 }
    Fields
    regionalRequirementsEntries[]

    object ( RegionalRequirementsEntry )

    List of regional requirements.

    RegionalRequirementsEntry

    Policy level regional legal violation details.

    JSON representation 
     { 
 "legalPolicy" 
 : 
 string 
 , 
 "countryRestrictions" 
 : 
 [ 
 { 
 object (  AdPolicyCriterionRestriction 
 
) 
 } 
 ] 
 }
    Fields
    legalPolicy

    string

    The legal policy that is being violated.
    countryRestrictions[]

    object ( AdPolicyCriterionRestriction )

    The countries restricted due to the legal policy.

    AdPolicyTopicConstraint

    Details on ad serving constraints.

    JSON representation 
     { 
 "requestCertificateFormLink" 
 : 
 string 
 , 
 // Union field constraint 
can be only one of the following: 
 "countryConstraint" 
 : 
 { 
 object (  AdPolicyCountryConstraintList 
 
) 
 } 
 , 
 "resellerConstraint" 
 : 
 { 
 object (  AdPolicyResellerConstraint 
 
) 
 } 
 , 
 "certificateMissingCountryList" 
 : 
 { 
 object (  AdPolicyCountryConstraintList 
 
) 
 } 
 , 
 "certificateDomainMismatchCountryList" 
 : 
 { 
 object (  AdPolicyCountryConstraintList 
 
) 
 } 
 , 
 "globalCertificateMissing" 
 : 
 { 
 object (  AdPolicyGlobalCertificateMissingConstraint 
 
) 
 } 
 , 
 "globalCertificateDomainMismatch" 
 : 
 { 
 object (  AdPolicyGlobalCertificateDomainMismatchConstraint 
 
) 
 } 
 // End of list of possible types for union field constraint 
. 
 }
    Fields
    Union field constraint . The serving constraint. constraint can be only one of the following:
    countryConstraint

    object ( AdPolicyCountryConstraintList )

    Countries where the ad cannot serve.

    resellerConstraint

    object ( AdPolicyResellerConstraint )

    Reseller constraint.

    certificateMissingCountryList

    object ( AdPolicyCountryConstraintList )

    Countries where a certificate is required for serving.

    certificateDomainMismatchCountryList

    object ( AdPolicyCountryConstraintList )

    Countries where the resource's domain is not covered by the certificates associated with it.

    globalCertificateMissing

    object ( AdPolicyGlobalCertificateMissingConstraint )

    Certificate is required to serve in any country.

    globalCertificateDomainMismatch

    object ( AdPolicyGlobalCertificateDomainMismatchConstraint )

    Certificate is required to serve in any country and the existing certificate does not cover the ad's domain.

    AdPolicyCountryConstraintList

    A list of countries where the ad cannot serve due to policy constraints.

    JSON representation 
     { 
 "countries" 
 : 
 [ 
 { 
 object (  AdPolicyCriterionRestriction 
 
) 
 } 
 ] 
 }
    Fields
    countries[]

    object ( AdPolicyCriterionRestriction )

    Countries where the ad cannot serve.

    AdPolicyResellerConstraint

    This type has no fields.

    Policy topic was constrained due to disapproval of the website for reseller purposes.

    AdPolicyGlobalCertificateMissingConstraint

    This type has no fields.

    Certificate is required to serve in any country.

    AdPolicyGlobalCertificateDomainMismatchConstraint

    This type has no fields.

    Certificate is required to serve in any country and the existing certificate does not cover the ad's domain.

    AdPolicyTopicAppealInfo

    Information on how to appeal a policy decision.

    JSON representation 
     { 
 "appealType" 
 : 
 enum (  AdPolicyAppealType 
 
) 
 , 
 "appealFormLink" 
 : 
 string 
 }
    Fields
    appealType

    enum ( AdPolicyAppealType )

    Whether the decision can be appealed through a self-service appeal or an appeal form.

    AdPolicyAppealType

    Possible types of appeal.

    Enums
    AD_POLICY_APPEAL_TYPE_UNKNOWN Unknown or not specified.
    SELF_SERVICE_APPEAL The decision can be appealed through a self-service appeal.
    APPEAL_FORM The decision can be appealed using an appeal form.

    DisplayVideoSourceAd

    The ad sourced from a DV360 creative.

    JSON representation 
     { 
 "creativeId" 
 : 
 string 
 }
    Fields
    creativeId

    string ( int64 format)

    The ID of the source creative.

    MastheadAd

    Details for a Masthead Ad.

    JSON representation 
     { 
 "video" 
 : 
 { 
 object (  YoutubeVideoDetails 
 
) 
 } 
 , 
 "headline" 
 : 
 string 
 , 
 "description" 
 : 
 string 
 , 
 "videoAspectRatio" 
 : 
 enum (  VideoAspectRatio 
 
) 
 , 
 "autoplayVideoStartMillisecond" 
 : 
 string 
 , 
 "autoplayVideoDuration" 
 : 
 string 
 , 
 "callToActionButtonLabel" 
 : 
 string 
 , 
 "callToActionFinalUrl" 
 : 
 string 
 , 
 "callToActionTrackingUrl" 
 : 
 string 
 , 
 "showChannelArt" 
 : 
 boolean 
 , 
 "companionYoutubeVideos" 
 : 
 [ 
 { 
 object (  YoutubeVideoDetails 
 
) 
 } 
 ] 
 }
    Fields
    video

    object ( YoutubeVideoDetails )

    The YouTube video used by the ad.
    headline

    string

    The headline of the ad.
    description

    string

    The description of the ad.
    videoAspectRatio

    enum ( VideoAspectRatio )

    The aspect ratio of the autoplaying YouTube video on the Masthead.
    autoplayVideoStartMillisecond

    string ( int64 format)

    The amount of time in milliseconds after which the video will start to play.
    autoplayVideoDuration

    string ( Duration format)

    The duration of time the video will autoplay.

    A duration in seconds with up to nine fractional digits, ending with ' s '. Example: "3.5s" .
    callToActionButtonLabel

    string

    The text on the call-to-action button.
    callToActionFinalUrl

    string

    The destination URL for the call-to-action button.
    callToActionTrackingUrl

    string

    The tracking URL for the call-to-action button.
    showChannelArt

    boolean

    Whether to show a background or banner that appears at the top of a YouTube page.
    companionYoutubeVideos[]

    object ( YoutubeVideoDetails )

    The videos that appear next to the Masthead Ad on desktop. Can be no more than two.

    YoutubeVideoDetails

    Details of a YouTube video.

    JSON representation 
     { 
 "id" 
 : 
 string 
 , 
 "unavailableReason" 
 : 
 enum (  VideoUnavailableReason 
 
) 
 , 
 "videoAssetId" 
 : 
 string 
 }
    Fields
    id

    string

    Output only. The YouTube video ID which can be searched on YouTube webpage.
    unavailableReason

    enum ( VideoUnavailableReason )

    The reason why the video data is not available.
    videoAssetId

    string ( int64 format)

    Required. The YouTube video asset id. This is the adAssetId of an AdAsset resource.

    VideoUnavailableReason

    Possible reasons why a video could be unavailable.

    Enums
    VIDEO_UNAVAILABLE_REASON_UNSPECIFIED Unknown or unspecified.
    VIDEO_UNAVAILABLE_REASON_PRIVATE The video is private.
    VIDEO_UNAVAILABLE_REASON_DELETED The video is deleted.

    VideoAspectRatio

    Possible aspect ratios for a YouTube video.

    Enums
    VIDEO_ASPECT_RATIO_UNSPECIFIED Not specified or unknown.
    VIDEO_ASPECT_RATIO_WIDESCREEN The video is stretched and the top and bottom are cropped.
    VIDEO_ASPECT_RATIO_FIXED_16_9 The video uses a fixed 16:9 aspect ratio.

    InStreamAd

    Details for an in-stream ad.

    JSON representation 
     { 
 "commonInStreamAttribute" 
 : 
 { 
 object (  CommonInStreamAttribute 
 
) 
 } 
 , 
 "customParameters" 
 : 
 { 
 string 
 : 
 string 
 , 
 ... 
 } 
 }
    Fields
    commonInStreamAttribute

    object ( CommonInStreamAttribute )

    Common ad attributes.
    customParameters

    map (key: string, value: string)

    The custom parameters and accompanying values to add to the tracking URL.

    An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" } .

    CommonInStreamAttribute

    Common attributes for in-stream, non-skippable and bumper ads.

    JSON representation 
     { 
 "displayUrl" 
 : 
 string 
 , 
 "finalUrl" 
 : 
 string 
 , 
 "trackingUrl" 
 : 
 string 
 , 
 "actionButtonLabel" 
 : 
 string 
 , 
 "actionHeadline" 
 : 
 string 
 , 
 "video" 
 : 
 { 
 object (  YoutubeVideoDetails 
 
) 
 } 
 , 
 "companionBanner" 
 : 
 { 
 object (  ImageAsset 
 
) 
 } 
 }
    Fields
    displayUrl

    string

    The webpage address that appears with the ad.
    finalUrl

    string

    The URL address of the webpage that people reach after they click the ad.
    trackingUrl

    string

    The URL address loaded in the background for tracking purposes.
    actionButtonLabel

    string

    The text on the call-to-action button.
    actionHeadline

    string

    The headline of the call-to-action banner.
    video

    object ( YoutubeVideoDetails )

    The YouTube video of the ad.
    companionBanner

    object ( ImageAsset )

    The image which shows next to the video ad.

    ImageAsset

    Meta data of an image asset.

    JSON representation 
     { 
 "mimeType" 
 : 
 string 
 , 
 "fullSize" 
 : 
 { 
 object (  Dimensions 
 
) 
 } 
 , 
 "fileSize" 
 : 
 string 
 , 
 "assetId" 
 : 
 string 
 }
    Fields
    mimeType

    string

    Output only. MIME type of the image asset.
    fullSize

    object ( Dimensions )

    Output only. Metadata for this image at its original size.
    fileSize

    string ( int64 format)

    Output only. File size of the image asset in bytes.
    assetId

    string ( int64 format)

    Required. The unique ID of the asset.

    NonSkippableAd

    Details for a non-skippable ad.

    JSON representation 
     { 
 "commonInStreamAttribute" 
 : 
 { 
 object (  CommonInStreamAttribute 
 
) 
 } 
 , 
 "customParameters" 
 : 
 { 
 string 
 : 
 string 
 , 
 ... 
 } 
 }
    Fields
    commonInStreamAttribute

    object ( CommonInStreamAttribute )

    Common ad attributes.
    customParameters

    map (key: string, value: string)

    The custom parameters and accompanying values to add to the tracking URL.

    An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" } .

    BumperAd

    Details for a bumper ad.

    JSON representation 
     { 
 "commonInStreamAttribute" 
 : 
 { 
 object (  CommonInStreamAttribute 
 
) 
 } 
 }
    Fields
    commonInStreamAttribute

    object ( CommonInStreamAttribute )

    Common ad attributes.

    AudioAd

    Details for an audio ad.

    JSON representation 
     { 
 "displayUrl" 
 : 
 string 
 , 
 "finalUrl" 
 : 
 string 
 , 
 "trackingUrl" 
 : 
 string 
 , 
 "video" 
 : 
 { 
 object (  YoutubeVideoDetails 
 
) 
 } 
 }
    Fields
    displayUrl

    string

    The webpage address that appears with the ad.
    finalUrl

    string

    The URL address of the webpage that people reach after they click the ad.
    trackingUrl

    string

    The URL address loaded in the background for tracking purposes.
    video

    object ( YoutubeVideoDetails )

    The YouTube video of the ad.

    VideoDiscoveryAd

    Details for a video discovery ad.

    JSON representation 
     { 
 "headline" 
 : 
 string 
 , 
 "description1" 
 : 
 string 
 , 
 "description2" 
 : 
 string 
 , 
 "video" 
 : 
 { 
 object (  YoutubeVideoDetails 
 
) 
 } 
 , 
 "thumbnail" 
 : 
 enum (  Thumbnail 
 
) 
 }
    Fields
    headline

    string

    The headline of ad.
    description1

    string

    First text line for the ad.
    description2

    string

    Second text line for the ad.
    video

    object ( YoutubeVideoDetails )

    The YouTube video the ad promotes.
    thumbnail

    enum ( Thumbnail )

    Thumbnail image used in the ad.

    Thumbnail

    Possible thumbnail options in Video Discovery Ads.

    Enums
    THUMBNAIL_UNSPECIFIED Unknown or unspecified.
    THUMBNAIL_DEFAULT The default thumbnail, can be auto-generated or user-uploaded.
    THUMBNAIL_1 Thumbnail 1, generated from the video.
    THUMBNAIL_2 Thumbnail 2, generated from the video.
    THUMBNAIL_3 Thumbnail 3, generated from the video.

    VideoPerformanceAd

    Details for a video performance ad.

    JSON representation 
     { 
 "finalUrl" 
 : 
 string 
 , 
 "trackingUrl" 
 : 
 string 
 , 
 "actionButtonLabels" 
 : 
 [ 
 string 
 ] 
 , 
 "headlines" 
 : 
 [ 
 string 
 ] 
 , 
 "longHeadlines" 
 : 
 [ 
 string 
 ] 
 , 
 "descriptions" 
 : 
 [ 
 string 
 ] 
 , 
 "displayUrlBreadcrumb1" 
 : 
 string 
 , 
 "displayUrlBreadcrumb2" 
 : 
 string 
 , 
 "domain" 
 : 
 string 
 , 
 "videos" 
 : 
 [ 
 { 
 object (  YoutubeVideoDetails 
 
) 
 } 
 ] 
 , 
 "customParameters" 
 : 
 { 
 string 
 : 
 string 
 , 
 ... 
 } 
 , 
 "companionBanners" 
 : 
 [ 
 { 
 object (  ImageAsset 
 
) 
 } 
 ] 
 }
    Fields
    finalUrl

    string

    The URL address of the webpage that people reach after they click the ad.
    trackingUrl

    string

    The URL address loaded in the background for tracking purposes.
    actionButtonLabels[]

    string

    The list of text assets shown on the call-to-action button.
    headlines[]

    string

    The list of headlines shown on the call-to-action banner.
    longHeadlines[]

    string

    The list of long headlines shown on the call-to-action banner.
    descriptions[]

    string

    The list of descriptions shown on the call-to-action banner.
    displayUrlBreadcrumb1

    string

    The first piece after the domain in the display URL.
    displayUrlBreadcrumb2

    string

    The second piece after the domain in the display URL.
    domain

    string

    The domain of the display URL.
    videos[]

    object ( YoutubeVideoDetails )

    The list of YouTube video assets used by this ad.
    customParameters

    map (key: string, value: string)

    The custom parameters and accompanying values to add to the tracking URL.

    An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" } .
    companionBanners[]

    object ( ImageAsset )

    The list of companion banners used by this ad.

    DemandGenVideoAd

    Details for a Demand Gen video ad.

    JSON representation 
     { 
 "finalUrl" 
 : 
 string 
 , 
 "trackingUrl" 
 : 
 string 
 , 
 "userSpecifiedTrackingUrl" 
 : 
 string 
 , 
 "callToAction" 
 : 
 enum (  CallToAction 
 
) 
 , 
 "headlines" 
 : 
 [ 
 string 
 ] 
 , 
 "longHeadlines" 
 : 
 [ 
 string 
 ] 
 , 
 "descriptions" 
 : 
 [ 
 string 
 ] 
 , 
 "displayUrlBreadcrumb1" 
 : 
 string 
 , 
 "displayUrlBreadcrumb2" 
 : 
 string 
 , 
 "videos" 
 : 
 [ 
 { 
 object (  YoutubeVideoDetails 
 
) 
 } 
 ] 
 , 
 "customParameters" 
 : 
 { 
 string 
 : 
 string 
 , 
 ... 
 } 
 , 
 "companionBanner" 
 : 
 { 
 object (  ImageAsset 
 
) 
 } 
 , 
 "logo" 
 : 
 { 
 object (  ImageAsset 
 
) 
 } 
 , 
 "finalMobileUrl" 
 : 
 string 
 , 
 "finalUrlSuffix" 
 : 
 string 
 , 
 "businessName" 
 : 
 string 
 }
    Fields
    finalUrl

    string

    Required. The URL address of the webpage that people reach after they click the ad.

    trackingUrl

    string

    Output only. The URL address loaded in the background for tracking purposes.

    userSpecifiedTrackingUrl

    string

    Optional. The tracking URL specified by the user manually.

    callToAction

    enum ( CallToAction )

    Required. The call-to-action button shown on the ad.

    The supported values are:

    • AUTOMATED
    • LEARN_MORE
    • GET_QUOTE
    • APPLY_NOW
    • SIGN_UP
    • CONTACT_US
    • SUBSCRIBE
    • DOWNLOAD
    • BOOK_NOW
    • SHOP_NOW
    • BUY_NOW
    • DONATE_NOW
    • ORDER_NOW
    • PLAY_NOW
    • SEE_MORE
    • START_NOW
    • VISIT_SITE
    • WATCH_NOW
    headlines[]

    string

    Required. The list of headlines shown on the ad.

    longHeadlines[]

    string

    Required. The list of long headlines shown on the ad.

    descriptions[]

    string

    Required. The list of descriptions shown on the ad.

    displayUrlBreadcrumb1

    string

    Optional. The first piece after the domain in the display URL.

    displayUrlBreadcrumb2

    string

    Optional. The second piece after the domain in the display URL.

    videos[]

    object ( YoutubeVideoDetails )

    Required. The list of YouTube video assets used by this ad.

    customParameters

    map (key: string, value: string)

    Optional. The custom parameters and accompanying values to add to the tracking URL.

    An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" } .

    companionBanner

    object ( ImageAsset )

    Optional. The companion banner used by this ad.

    finalMobileUrl

    string

    Optional. The URL address of the webpage that people reach after they click the ad on a mobile device.

    finalUrlSuffix

    string

    Optional. The suffix to append to landing page URLs.

    businessName

    string

    Required. The business name shown on the ad.

    CallToAction

    Possible call-to-action values for Demand Gen Product/Video ads.

    Enums
    CALL_TO_ACTION_UNSPECIFIED Not specified or unknown.
    AUTOMATED Automated.
    LEARN_MORE Learn more.
    GET_QUOTE Get quote.
    APPLY_NOW Apply now.
    SIGN_UP Sign up.
    CONTACT_US Contact us.
    SUBSCRIBE Subscribe.
    DOWNLOAD Download.
    BOOK_NOW Book now.
    SHOP_NOW Shop now.
    BUY_NOW Buy now.
    DONATE_NOW Donate now.
    ORDER_NOW Order now.
    PLAY_NOW Play now.
    SEE_MORE See more.
    START_NOW Start now.
    VISIT_SITE Visit site.
    WATCH_NOW Watch now.

    DemandGenImageAd

    Details for a Demand Gen image ad.

    JSON representation 
     { 
 "finalUrl" 
 : 
 string 
 , 
 "trackingUrl" 
 : 
 string 
 , 
 "userSpecifiedTrackingUrl" 
 : 
 string 
 , 
 "callToAction" 
 : 
 string 
 , 
 "headlines" 
 : 
 [ 
 string 
 ] 
 , 
 "descriptions" 
 : 
 [ 
 string 
 ] 
 , 
 "customParameters" 
 : 
 { 
 string 
 : 
 string 
 , 
 ... 
 } 
 , 
 "finalMobileUrl" 
 : 
 string 
 , 
 "finalUrlSuffix" 
 : 
 string 
 , 
 "businessName" 
 : 
 string 
 , 
 "marketingImages" 
 : 
 [ 
 { 
 object (  ImageAsset 
 
) 
 } 
 ] 
 , 
 "squareMarketingImages" 
 : 
 [ 
 { 
 object (  ImageAsset 
 
) 
 } 
 ] 
 , 
 "portraitMarketingImages" 
 : 
 [ 
 { 
 object (  ImageAsset 
 
) 
 } 
 ] 
 , 
 "logoImages" 
 : 
 [ 
 { 
 object (  ImageAsset 
 
) 
 } 
 ] 
 }
    Fields
    finalUrl

    string

    Required. The URL address of the webpage that people reach after they click the ad.
    trackingUrl

    string

    Output only. The URL address loaded in the background for tracking purposes.
    userSpecifiedTrackingUrl

    string

    Optional. The tracking URL specified by the user manually.
    callToAction

    string

    Required. The call-to-action button shown on the ad.
    headlines[]

    string

    Required. The list of headlines shown on the ad.
    descriptions[]

    string

    Required. The list of descriptions shown on the ad.
    customParameters

    map (key: string, value: string)

    Optional. The custom parameters and accompanying values to add to the tracking URL.

    An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" } .
    finalMobileUrl

    string

    Optional. The URL address of the webpage that people reach after they click the ad on a mobile device.
    finalUrlSuffix

    string

    Optional. The suffix to append to landing page URLs.
    businessName

    string

    Required. The business name shown on the ad.
    marketingImages[]

    object ( ImageAsset )

    The list of marketing images shown on the ad.
    squareMarketingImages[]

    object ( ImageAsset )

    The list of square marketing images shown on the ad.
    portraitMarketingImages[]

    object ( ImageAsset )

    The list of portrait marketing images shown on the ad.
    logoImages[]

    object ( ImageAsset )

    The list of logo images shown on the ad.

    DemandGenCarouselAd

    Details for a Demand Gen carousel ad.

    JSON representation 
     { 
 "finalUrl" 
 : 
 string 
 , 
 "headline" 
 : 
 string 
 , 
 "description" 
 : 
 string 
 , 
 "cards" 
 : 
 [ 
 { 
 object (  CarouselCard 
 
) 
 } 
 ] 
 , 
 "finalUrlSuffix" 
 : 
 string 
 , 
 "trackingUrl" 
 : 
 string 
 , 
 "userSpecifiedTrackingUrl" 
 : 
 string 
 , 
 "businessName" 
 : 
 string 
 , 
 "customParameters" 
 : 
 { 
 string 
 : 
 string 
 , 
 ... 
 } 
 , 
 "logo" 
 : 
 { 
 object (  ImageAsset 
 
) 
 } 
 }
    Fields
    finalUrl

    string

    Required. The URL address of the webpage that people reach after they click the ad.
    headline

    string

    Required. The headline of the ad.
    description

    string

    Required. The description of the ad.
    cards[]

    object ( CarouselCard )

    Required. The list of cards shown on the ad.
    finalUrlSuffix

    string

    Optional. The suffix to append to landing page URLs.
    trackingUrl

    string

    Output only. The URL address loaded in the background for tracking purposes.
    userSpecifiedTrackingUrl

    string

    Optional. The tracking URL specified by the user manually.
    businessName

    string

    Required. The business name shown on the ad.
    customParameters

    map (key: string, value: string)

    Optional. The custom parameters and accompanying values to add to the tracking URL.

    An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" } .

    CarouselCard

    Details for a Demand Gen carousel card.

    JSON representation 
     { 
 "finalUrl" 
 : 
 string 
 , 
 "finalMobileUrl" 
 : 
 string 
 , 
 "headline" 
 : 
 string 
 , 
 "callToAction" 
 : 
 string 
 , 
 "marketingImage" 
 : 
 { 
 object (  ImageAsset 
 
) 
 } 
 , 
 "squareMarketingImage" 
 : 
 { 
 object (  ImageAsset 
 
) 
 } 
 , 
 "portraitMarketingImage" 
 : 
 { 
 object (  ImageAsset 
 
) 
 } 
 }
    Fields
    finalUrl

    string

    Required. The URL address of the webpage that people reach after they click the card.
    finalMobileUrl

    string

    Optional. The URL address of the webpage that people reach after they click the card on a mobile device.
    headline

    string

    Required. The headline of the card.
    callToAction

    string

    Required. The text on the call-to-action button shown on the card.

    Must use 10 characters or less.
    marketingImage

    object ( ImageAsset )

    Optional. The marketing image shown on the card.
    squareMarketingImage

    object ( ImageAsset )

    Optional. The square marketing image shown on the card.
    portraitMarketingImage

    object ( ImageAsset )

    Optional. The portrait marketing image shown on the card.

    DemandGenProductAd

    Details for a Demand Gen product ad.

    JSON representation 
     { 
 "finalUrl" 
 : 
 string 
 , 
 "headline" 
 : 
 string 
 , 
 "description" 
 : 
 string 
 , 
 "finalUrlSuffix" 
 : 
 string 
 , 
 "callToAction" 
 : 
 enum (  CallToAction 
 
) 
 , 
 "trackingUrl" 
 : 
 string 
 , 
 "userSpecifiedTrackingUrl" 
 : 
 string 
 , 
 "businessName" 
 : 
 string 
 , 
 "customParameters" 
 : 
 { 
 string 
 : 
 string 
 , 
 ... 
 } 
 , 
 "logo" 
 : 
 { 
 object (  ImageAsset 
 
) 
 } 
 , 
 "displayUrlBreadcrumb1" 
 : 
 string 
 , 
 "displayUrlBreadcrumb2" 
 : 
 string 
 }
    Fields
    finalUrl

    string

    Required. The URL address of the webpage that people reach after they click the ad.

    headline

    string

    Required. The headline of the ad.

    description

    string

    Required. The description of the ad.

    finalUrlSuffix

    string

    Optional. The suffix to append to landing page URLs.

    callToAction

    enum ( CallToAction )

    Required. The call-to-action button shown on the ad.

    The supported values are:

    • AUTOMATED
    • APPLY_NOW
    • BOOK_NOW
    • CONTACT_US
    • DOWNLOAD
    • GET_QUOTE
    • LEARN_MORE
    • SHOP_NOW
    • SIGN_UP
    • SUBSCRIBE
    trackingUrl

    string

    Output only. The URL address loaded in the background for tracking purposes.

    userSpecifiedTrackingUrl

    string

    Optional. The tracking URL specified by the user manually.

    businessName

    string

    Required. The business name shown on the ad.

    customParameters

    map (key: string, value: string)

    Optional. The custom parameters and accompanying values to add to the tracking URL.

    An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" } .

    displayUrlBreadcrumb1

    string

    Optional. The first piece after the domain in the display URL.

    displayUrlBreadcrumb2

    string

    Optional. The second piece after the domain in the display URL.

    AdUrl

    Additional URLs related to the ad, including beacons.

    JSON representation 
     { 
 "type" 
 : 
 enum (  AdUrlType 
 
) 
 , 
 "url" 
 : 
 string 
 }
    Fields
    type

    enum ( AdUrlType )

    The type of the Ad URL.
    url

    string

    The URL string value.

    AdUrlType

    Possible ad URL types.

    Enums
    AD_URL_TYPE_UNSPECIFIED Unknown or unspecified.
    AD_URL_TYPE_BEACON_IMPRESSION A 1x1 tracking pixel to ping when an impression of a creative is delivered.
    AD_URL_TYPE_BEACON_EXPANDABLE_DCM_IMPRESSION Expandable DCM impression beacon. At serving time, it is expanded to several beacons.
    AD_URL_TYPE_BEACON_CLICK Tracking URL to ping when the click event is triggered.
    AD_URL_TYPE_BEACON_SKIP Tracking URL to ping when the skip event is triggered.

    DcmTrackingInfo

    Details on the DCM tracking.

    JSON representation 
     { 
 "placementId" 
 : 
 string 
 , 
 "trackingAdId" 
 : 
 string 
 , 
 "creativeId" 
 : 
 string 
 }
    Fields
    placementId

    string ( int64 format)

    Required. The DCM placement id.
    trackingAdId

    string ( int64 format)

    Required. The DCM tracking ad id.
    creativeId

    string ( int64 format)

    Required. The DCM creative id.

    Methods

    create

    		Creates an ad group ad.

    delete

    		Deletes an ad group ad.

    get

    		Gets an ad group ad.

    list

    		Lists ad group ads.

    patch

    		Updates an ad group ad.
    Create a Mobile Website
    View Site in Mobile | Classic
    Share by: