AdGroup

List up AdGroups.

Changed on

List up all AdGroups of the Campaign.

get/cm/v1/ad-groups

Request

Query parameters

ad_account_idstring required

The AdAccount ID to which AdGroups belong to.

product_idstring

The Product ID to which AdGroups belong to.

campaign_idstring

The Campaign ID which AdGroups belong to. If not specified, response will contains all AdGroups under the Product.

inquiry_option'UNKNOWN_INQUIRY_OPTION' | 'INQUIRY_ENTITY' | 'INQUIRY_OVERVIEW' | 'INQUIRY_ALL'

InquiryOption to specify which information to retrieve.

  • INQUIRY_ENTITY: Only the target entity itself is returned in response. This InquiryOption is faster than other options as it reads the single entity from the database.
  • INQUIRY_OVERVIEW: The target entity's overview information is returned in response. In general, the overview information includes the brief content of the target entity and its related entities. This InquiryOption is slower than INQUIRY_ENTITY but the returned data size is usually smaller than that.
  • INQUIRY_ALL: The target entity and its summary information is returned in response. This InquiryOption is equivalent to INQUIRY_ENTITY + INQUIRY_OVERVIEW, and it's slow and big.

Response

A successful response.

Changes

    • warning

      added the new CTV_WEB_USER_ACQUISITION enum value to the // response property for the response status

    • warning

      added the new LEARNING enum value to the // response property for the response status

    • warning

      added the new PUBLICA enum value to the ////// response property for the response status

    • warning

      added the new PUBLICA enum value to the ////// response property for the response status

    • warning

      added the new PUBLICA enum value to the ///// response property for the response status

    • warning

      added the new PUBLICA enum value to the ///// response property for the response status

    • warning

      added the new SPRINGSERVE enum value to the ////// response property for the response status

    • warning

      added the new SPRINGSERVE enum value to the ////// response property for the response status

    • warning

      added the new SPRINGSERVE enum value to the ///// response property for the response status

    • warning

      added the new SPRINGSERVE enum value to the ///// response property for the response status