Console
    Start free

    Google Ads Ad Manager V1 Client - Class SearchAdReviewCenterAdsRequest (0.5.0)

    Reference documentation and code samples for the Google Ads Ad Manager V1 Client class SearchAdReviewCenterAdsRequest.

    Request object for SearchAdReviewCenterAds method.

    Generated from protobuf message google.ads.admanager.v1.SearchAdReviewCenterAdsRequest

    Namespace

    Google \ Ads \ AdManager \ V1

    Methods

    __construct

    Constructor.

    Parameters
    Name
    Description
    data
    array

    Optional. Data for populating the Message object.

    ↳ parent
    string

    Required. The parent, which owns this collection of AdReviewCenterAds. Format: networks/{network_code}/webProperties/{web_property_code} Since a network can only have a single web property of each ExchangeSyndicationProduct , you can use the ExchangeSyndicationProduct as an alias for the web property code: networks/{network_code}/webProperties/display networks/{network_code}/webProperties/videoAndAudio networks/{network_code}/webProperties/mobileApp networks/{network_code}/webProperties/games

    ↳ page_size
    int

    Optional. The maximum number of AdReviewCenterAds to return. The service may return fewer than this value. If unspecified, at most 50 AdReviewCenterAds will be returned. The maximum value is 1000; values greater than 1000 will be coerced to 1000.

    ↳ page_token
    string

    Optional. The page token to fetch the next page of AdReviewCenterAds. This is the value returned from a previous Search request, or empty.

    ↳ status
    int

    Required. Only return ads with the given status.

    ↳ ad_review_center_ad_id
    array

    Optional. If provided, only return ads with the given AdReviewCenterAd IDs.

    ↳ date_time_range
    Google\Type\Interval

    Optional. If provided, only return ads that served within the given date range (inclusive). The date range must be within the last 30 days. If not provided, the date range will be the last 30 days.

    ↳ search_text
    array

    Optional. If provided, restrict the search to AdReviewCenterAds associated with the text (including any text on the ad or in the destination URL). If more than one value is provided, the search will combine them in a logical AND. For example, ['car', 'blue'] will match ads that contain both "car" and "blue", but not an ad that only contains "car".

    ↳ buyer_account_id
    array

    Optional. If provided, restrict the search to creatives belonging to one of the given Adx buyer account IDs. Only applicable to RTB creatives. Adx buyer account IDs can be found via the ProgrammaticBuyerService.

    getParent

    Required. The parent, which owns this collection of AdReviewCenterAds.

    Format: networks/{network_code}/webProperties/{web_property_code} Since a network can only have a single web property of each ExchangeSyndicationProduct , you can use the ExchangeSyndicationProduct as an alias for the web property code: networks/{network_code}/webProperties/display networks/{network_code}/webProperties/videoAndAudio networks/{network_code}/webProperties/mobileApp networks/{network_code}/webProperties/games

    Returns
    Type
    Description
    string

    setParent

    Required. The parent, which owns this collection of AdReviewCenterAds.

    Format: networks/{network_code}/webProperties/{web_property_code} Since a network can only have a single web property of each ExchangeSyndicationProduct , you can use the ExchangeSyndicationProduct as an alias for the web property code: networks/{network_code}/webProperties/display networks/{network_code}/webProperties/videoAndAudio networks/{network_code}/webProperties/mobileApp networks/{network_code}/webProperties/games

    Parameter
    Name
    Description
    var
    string
    Returns
    Type
    Description
    $this

    getPageSize

    Optional. The maximum number of AdReviewCenterAds to return. The service may return fewer than this value. If unspecified, at most 50 AdReviewCenterAds will be returned. The maximum value is 1000; values greater than 1000 will be coerced to 1000.

    Returns
    Type
    Description
    int

    setPageSize

    Optional. The maximum number of AdReviewCenterAds to return. The service may return fewer than this value. If unspecified, at most 50 AdReviewCenterAds will be returned. The maximum value is 1000; values greater than 1000 will be coerced to 1000.

    Parameter
    Name
    Description
    var
    int
    Returns
    Type
    Description
    $this

    getPageToken

    Optional. The page token to fetch the next page of AdReviewCenterAds. This is the value returned from a previous Search request, or empty.

    Returns
    Type
    Description
    string

    setPageToken

    Optional. The page token to fetch the next page of AdReviewCenterAds. This is the value returned from a previous Search request, or empty.

    Parameter
    Name
    Description
    var
    string
    Returns
    Type
    Description
    $this

    getStatus

    Required. Only return ads with the given status.

    Returns
    Type
    Description
    int
    Enum of type AdReviewCenterAdStatus .

    setStatus

    Required. Only return ads with the given status.

    Parameter
    Name
    Description
    var
    int

    Enum of type AdReviewCenterAdStatus .

    Returns
    Type
    Description
    $this

    getAdReviewCenterAdId

    Optional. If provided, only return ads with the given AdReviewCenterAd IDs.

    Returns
    Type
    Description
    Google\Protobuf\Internal\RepeatedField

    setAdReviewCenterAdId

    Optional. If provided, only return ads with the given AdReviewCenterAd IDs.

    Parameter
    Name
    Description
    var
    string[]
    Returns
    Type
    Description
    $this

    getDateTimeRange

    Optional. If provided, only return ads that served within the given date range (inclusive). The date range must be within the last 30 days. If not provided, the date range will be the last 30 days.

    Returns
    Type
    Description
    Google\Type\Interval |null

    hasDateTimeRange

    clearDateTimeRange

    setDateTimeRange

    Optional. If provided, only return ads that served within the given date range (inclusive). The date range must be within the last 30 days. If not provided, the date range will be the last 30 days.

    Parameter
    Name
    Description
    var
    Google\Type\Interval
    Returns
    Type
    Description
    $this

    getSearchText

    Optional. If provided, restrict the search to AdReviewCenterAds associated with the text (including any text on the ad or in the destination URL). If more than one value is provided, the search will combine them in a logical AND. For example, ['car', 'blue'] will match ads that contain both "car" and "blue", but not an ad that only contains "car".

    Returns
    Type
    Description
    Google\Protobuf\Internal\RepeatedField

    setSearchText

    Optional. If provided, restrict the search to AdReviewCenterAds associated with the text (including any text on the ad or in the destination URL). If more than one value is provided, the search will combine them in a logical AND. For example, ['car', 'blue'] will match ads that contain both "car" and "blue", but not an ad that only contains "car".

    Parameter
    Name
    Description
    var
    string[]
    Returns
    Type
    Description
    $this

    getBuyerAccountId

    Optional. If provided, restrict the search to creatives belonging to one of the given Adx buyer account IDs. Only applicable to RTB creatives. Adx buyer account IDs can be found via the ProgrammaticBuyerService.

    Returns
    Type
    Description
    Google\Protobuf\Internal\RepeatedField

    setBuyerAccountId

    Optional. If provided, restrict the search to creatives belonging to one of the given Adx buyer account IDs. Only applicable to RTB creatives. Adx buyer account IDs can be found via the ProgrammaticBuyerService.

    Parameter
    Name
    Description
    var
    int[]|string[]| Google\Protobuf\Internal\RepeatedField
    Returns
    Type
    Description
    $this

    static::build

    Parameter
    Name
    Description
    parent
    string

    Required. The parent, which owns this collection of AdReviewCenterAds. Format: networks/{network_code}/webProperties/{web_property_code}

    Since a network can only have a single web property of each ExchangeSyndicationProduct , you can use the ExchangeSyndicationProduct as an alias for the web property code:

    networks/{network_code}/webProperties/display

    networks/{network_code}/webProperties/videoAndAudio

    networks/{network_code}/webProperties/mobileApp

    networks/{network_code}/webProperties/games Please see AdReviewCenterAdServiceClient::webPropertyName() for help formatting this field.

    Returns
    Type
    Description
    SearchAdReviewCenterAdsRequest
    Design a Mobile Site
    View Site in Mobile | Classic
    Share by: