Blame - docs/dyn/dfareporting_v3_3.advertiserGroups.html - platform/external/python/google-api-python-client

blob: 495520406db5952d6f72e88554d1c183330b9bcf [file] [log] [blame]

Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	1	<html><body>
				2	<style>
				3
				4	body, h1, h2, h3, div, span, p, pre, a {
				5	margin: 0;
				6	padding: 0;
				7	border: 0;
				8	font-weight: inherit;
				9	font-style: inherit;
				10	font-size: 100%;
				11	font-family: inherit;
				12	vertical-align: baseline;
				13	}
				14
				15	body {
				16	font-size: 13px;
				17	padding: 1em;
				18	}
				19
				20	h1 {
				21	font-size: 26px;
				22	margin-bottom: 1em;
				23	}
				24
				25	h2 {
				26	font-size: 24px;
				27	margin-bottom: 1em;
				28	}
				29
				30	h3 {
				31	font-size: 20px;
				32	margin-bottom: 1em;
				33	margin-top: 1em;
				34	}
				35
				36	pre, code {
				37	line-height: 1.5;
				38	font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
				39	}
				40
				41	pre {
				42	margin-top: 0.5em;
				43	}
				44
				45	h1, h2, h3, p {
				46	font-family: Arial, sans serif;
				47	}
				48
				49	h1, h2, h3 {
				50	border-bottom: solid #CCC 1px;
				51	}
				52
				53	.toc_element {
				54	margin-top: 0.5em;
				55	}
				56
				57	.firstline {
				58	margin-left: 2 em;
				59	}
				60
				61	.method {
				62	margin-top: 1em;
				63	border: solid 1px #CCC;
				64	padding: 1em;
				65	background: #EEE;
				66	}
				67
				68	.details {
				69	font-weight: bold;
				70	font-size: 14px;
				71	}
				72
				73	</style>
				74
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	75	<h1><a href="dfareporting_v3_3.html">Campaign Manager 360 API</a> . <a href="dfareporting_v3_3.advertiserGroups.html">advertiserGroups</a></h1>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	76	<h2>Instance Methods</h2>
				77	<p class="toc_element">
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	78	<code><a href="#close">close()</a></code></p>
				79	<p class="firstline">Close httplib2 connections.</p>
				80	<p class="toc_element">
				81	<code><a href="#delete">delete(profileId, id, x__xgafv=None)</a></code></p>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	82	<p class="firstline">Deletes an existing advertiser group.</p>
				83	<p class="toc_element">
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	84	<code><a href="#get">get(profileId, id, x__xgafv=None)</a></code></p>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	85	<p class="firstline">Gets one advertiser group by ID.</p>
				86	<p class="toc_element">
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	87	<code><a href="#insert">insert(profileId, body=None, x__xgafv=None)</a></code></p>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	88	<p class="firstline">Inserts a new advertiser group.</p>
				89	<p class="toc_element">
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	90	<code><a href="#list">list(profileId, ids=None, maxResults=None, pageToken=None, searchString=None, sortField=None, sortOrder=None, x__xgafv=None)</a></code></p>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	91	<p class="firstline">Retrieves a list of advertiser groups, possibly filtered. This method supports paging.</p>
				92	<p class="toc_element">
				93	<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
				94	<p class="firstline">Retrieves the next page of results.</p>
				95	<p class="toc_element">
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	96	<code><a href="#patch">patch(profileId, id, body=None, x__xgafv=None)</a></code></p>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	97	<p class="firstline">Updates an existing advertiser group. This method supports patch semantics.</p>
				98	<p class="toc_element">
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	99	<code><a href="#update">update(profileId, body=None, x__xgafv=None)</a></code></p>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	100	<p class="firstline">Updates an existing advertiser group.</p>
				101	<h3>Method Details</h3>
				102	<div class="method">
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	103	<code class="details" id="close">close()</code>
				104	<pre>Close httplib2 connections.</pre>
				105	</div>
				106
				107	<div class="method">
				108	<code class="details" id="delete">delete(profileId, id, x__xgafv=None)</code>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	109	<pre>Deletes an existing advertiser group.
				110
				111	Args:
				112	profileId: string, User profile ID associated with this request. (required)
				113	id: string, Advertiser group ID. (required)
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	114	x__xgafv: string, V1 error format.
				115	Allowed values
				116	1 - v1 error format
				117	2 - v2 error format
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	118	</pre>
				119	</div>
				120
				121	<div class="method">
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	122	<code class="details" id="get">get(profileId, id, x__xgafv=None)</code>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	123	<pre>Gets one advertiser group by ID.
				124
				125	Args:
				126	profileId: string, User profile ID associated with this request. (required)
				127	id: string, Advertiser group ID. (required)
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	128	x__xgafv: string, V1 error format.
				129	Allowed values
				130	1 - v1 error format
				131	2 - v2 error format
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	132
				133	Returns:
				134	An object of the form:
				135
				136	{ # Groups advertisers together so that reports can be generated for the entire group at once.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	137	"accountId": "A String", # Account ID of this advertiser group. This is a read-only field that can be left blank.
				138	"id": "A String", # ID of this advertiser group. This is a read-only, auto-generated field.
				139	"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#advertiserGroup".
				140	"name": "A String", # Name of this advertiser group. This is a required field and must be less than 256 characters long and unique among advertiser groups of the same account.
				141	}</pre>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	142	</div>
				143
				144	<div class="method">
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	145	<code class="details" id="insert">insert(profileId, body=None, x__xgafv=None)</code>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	146	<pre>Inserts a new advertiser group.
				147
				148	Args:
				149	profileId: string, User profile ID associated with this request. (required)
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	150	body: object, The request body.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	151	The object takes the form of:
				152
				153	{ # Groups advertisers together so that reports can be generated for the entire group at once.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	154	"accountId": "A String", # Account ID of this advertiser group. This is a read-only field that can be left blank.
				155	"id": "A String", # ID of this advertiser group. This is a read-only, auto-generated field.
				156	"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#advertiserGroup".
				157	"name": "A String", # Name of this advertiser group. This is a required field and must be less than 256 characters long and unique among advertiser groups of the same account.
				158	}
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	159
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	160	x__xgafv: string, V1 error format.
				161	Allowed values
				162	1 - v1 error format
				163	2 - v2 error format
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	164
				165	Returns:
				166	An object of the form:
				167
				168	{ # Groups advertisers together so that reports can be generated for the entire group at once.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	169	"accountId": "A String", # Account ID of this advertiser group. This is a read-only field that can be left blank.
				170	"id": "A String", # ID of this advertiser group. This is a read-only, auto-generated field.
				171	"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#advertiserGroup".
				172	"name": "A String", # Name of this advertiser group. This is a required field and must be less than 256 characters long and unique among advertiser groups of the same account.
				173	}</pre>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	174	</div>
				175
				176	<div class="method">
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	177	<code class="details" id="list">list(profileId, ids=None, maxResults=None, pageToken=None, searchString=None, sortField=None, sortOrder=None, x__xgafv=None)</code>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	178	<pre>Retrieves a list of advertiser groups, possibly filtered. This method supports paging.
				179
				180	Args:
				181	profileId: string, User profile ID associated with this request. (required)
Yoshi Automation Bot	0bf565c	2020-12-09 08:56:03 -0800	[diff] [blame]	182	ids: string, Select only advertiser groups with these IDs. (repeated)
Yoshi Automation Bot	0bf565c	2020-12-09 08:56:03 -0800	[diff] [blame]	183	maxResults: integer, Maximum number of results to return.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	184	pageToken: string, Value of the nextPageToken from the previous result page.
Yoshi Automation Bot	b6971b0	2020-11-26 17:16:03 -0800	[diff] [blame]	185	searchString: string, Allows searching for objects by name or ID. Wildcards () are allowed. For example, "advertiser2015" will return objects with names like "advertiser group June 2015", "advertiser group April 2015", or simply "advertiser group 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "advertisergroup" will match objects with name "my advertisergroup", "advertisergroup 2015", or simply "advertisergroup".
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	186	sortField: string, Field by which to sort the list.
				187	Allowed values
				188	ID -
				189	NAME -
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	190	sortOrder: string, Order of sorted results.
				191	Allowed values
				192	ASCENDING -
				193	DESCENDING -
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	194	x__xgafv: string, V1 error format.
				195	Allowed values
				196	1 - v1 error format
				197	2 - v2 error format
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	198
				199	Returns:
				200	An object of the form:
				201
				202	{ # Advertiser Group List Response
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	203	"advertiserGroups": [ # Advertiser group collection.
				204	{ # Groups advertisers together so that reports can be generated for the entire group at once.
				205	"accountId": "A String", # Account ID of this advertiser group. This is a read-only field that can be left blank.
				206	"id": "A String", # ID of this advertiser group. This is a read-only, auto-generated field.
				207	"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#advertiserGroup".
				208	"name": "A String", # Name of this advertiser group. This is a required field and must be less than 256 characters long and unique among advertiser groups of the same account.
				209	},
				210	],
				211	"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#advertiserGroupsListResponse".
				212	"nextPageToken": "A String", # Pagination token to be used for the next list operation.
				213	}</pre>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	214	</div>
				215
				216	<div class="method">
				217	<code class="details" id="list_next">list_next(previous_request, previous_response)</code>
				218	<pre>Retrieves the next page of results.
				219
				220	Args:
				221	previous_request: The request for the previous page. (required)
				222	previous_response: The response from the request for the previous page. (required)
				223
				224	Returns:
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	225	A request object that you can call 'execute()' on to request the next
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	226	page. Returns None if there are no more items in the collection.
				227	</pre>
				228	</div>
				229
				230	<div class="method">
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	231	<code class="details" id="patch">patch(profileId, id, body=None, x__xgafv=None)</code>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	232	<pre>Updates an existing advertiser group. This method supports patch semantics.
				233
				234	Args:
				235	profileId: string, User profile ID associated with this request. (required)
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	236	id: string, AdvertiserGroup ID. (required)
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	237	body: object, The request body.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	238	The object takes the form of:
				239
				240	{ # Groups advertisers together so that reports can be generated for the entire group at once.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	241	"accountId": "A String", # Account ID of this advertiser group. This is a read-only field that can be left blank.
				242	"id": "A String", # ID of this advertiser group. This is a read-only, auto-generated field.
				243	"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#advertiserGroup".
				244	"name": "A String", # Name of this advertiser group. This is a required field and must be less than 256 characters long and unique among advertiser groups of the same account.
				245	}
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	246
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	247	x__xgafv: string, V1 error format.
				248	Allowed values
				249	1 - v1 error format
				250	2 - v2 error format
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	251
				252	Returns:
				253	An object of the form:
				254
				255	{ # Groups advertisers together so that reports can be generated for the entire group at once.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	256	"accountId": "A String", # Account ID of this advertiser group. This is a read-only field that can be left blank.
				257	"id": "A String", # ID of this advertiser group. This is a read-only, auto-generated field.
				258	"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#advertiserGroup".
				259	"name": "A String", # Name of this advertiser group. This is a required field and must be less than 256 characters long and unique among advertiser groups of the same account.
				260	}</pre>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	261	</div>
				262
				263	<div class="method">
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	264	<code class="details" id="update">update(profileId, body=None, x__xgafv=None)</code>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	265	<pre>Updates an existing advertiser group.
				266
				267	Args:
				268	profileId: string, User profile ID associated with this request. (required)
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	269	body: object, The request body.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	270	The object takes the form of:
				271
				272	{ # Groups advertisers together so that reports can be generated for the entire group at once.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	273	"accountId": "A String", # Account ID of this advertiser group. This is a read-only field that can be left blank.
				274	"id": "A String", # ID of this advertiser group. This is a read-only, auto-generated field.
				275	"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#advertiserGroup".
				276	"name": "A String", # Name of this advertiser group. This is a required field and must be less than 256 characters long and unique among advertiser groups of the same account.
				277	}
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	278
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	279	x__xgafv: string, V1 error format.
				280	Allowed values
				281	1 - v1 error format
				282	2 - v2 error format
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	283
				284	Returns:
				285	An object of the form:
				286
				287	{ # Groups advertisers together so that reports can be generated for the entire group at once.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	288	"accountId": "A String", # Account ID of this advertiser group. This is a read-only field that can be left blank.
				289	"id": "A String", # ID of this advertiser group. This is a read-only, auto-generated field.
				290	"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#advertiserGroup".
				291	"name": "A String", # Name of this advertiser group. This is a required field and must be less than 256 characters long and unique among advertiser groups of the same account.
				292	}</pre>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	293	</div>
				294
				295	</body></html>